cryptofont-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d123dafc342581fd42a1112bc5653bf541f9e40170f73c5d720fd9444740f48
-  data.tar.gz: 694805c32469960c1f0db9a3f07f7e757575f6bada05ef05be871265c390443b
+  metadata.gz: 3adb5e398a30cbafc8eeeea5238d1f5f099569dc3f121f16711c8cb2af84f797
+  data.tar.gz: c5efb210ce66c550387332f1165bd566609a8fb5932a532177b7a3a21f90f23f
 SHA512:
-  metadata.gz: a6420525c99175b4e8ffb78120a23b84776aacdd15a1529a5872bdec7e0d77bbc43c237b1d8db49ce56d5f3530ae1176745df54395045321771b44e8f78ef026
-  data.tar.gz: aeeaef0726df22a85508d52644b57d73d440ac247dd8177dae2a01b02e7f8bab785fa7b82820e51fa21e179d50e5f6b130cfeeb51df6a5b9116b7a9a633041ca
+  metadata.gz: 9743115ee61c97c57e0079ba9595ae3c2de676f41ef9fa396e189467be21eed1d18cf7ca0167edf2baf969453741885cbee8dffc43505abab01d9defb70ebe19
+  data.tar.gz: 3e7edbfb1b1d60a4cbc4e65db669c7de4254b6df57669a3bb44b6e54e34b6cddb0db55ea106e2483ee02a960df9af6bad0bdaf22cd0f9394771592a4db69e9ff

data/README.md

@@ -1,8 +1,6 @@
-# Cryptofont::Rails
+# cryptofont-rails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cryptofont/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Cryptofont-rails provides the [Cryptofont](https://cryptofont.com/) web fonts and styles as Rails engine for use with the asset pipeline.
 
 ## Installation
 
@@ -22,13 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your `application.css`, include the css file:
+```
+/*
+ * require cryptofont
+ */
+```
+Then restart your webserver if it was peviously running.
+Congratulation! You now have cryptofont icon support.
+
+### SASS Support
+It you prefer SCSS, add this to your `application.css.scss` file:
+```
+@import "cryptofont";
+```
+If you use the SASS indented syntax, add this to your `application.css.sass` file:
+```
+@import cryptofont
+```
+
+## Helpers
+There are also some helpers `cf_icon` that make your views better read and cleaner.
 
-## Development
+```ruby
+cf_icon "btc"
+# => <i class="cf-btc"></i>
+
+cf_icon "ltc", text: "Litecoin"
+# => <i class="cf-litecoin"></i> Litecoin
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+cf_icon "eth", text: "Ethereum", right: true
+# => Ethereum <i class="cf-eth"></i>
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+cf_icon "dash 4x", text: "Dash"
+# => <i class="cf-dash cf-4x"></i>
+```
 
 ## Contributing
 
@@ -36,7 +62,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/frizbe
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+* The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 * The font is licensed under the SIL OFL 1.1 http://scripts.sil.org/OFL
 * The CSS files are licensed under the MIT License http://opensource.org/licenses/mit-license.htm
 * Attribution is not required, but much appreciated CryptoFont by @AMPoellmann (alexanderpoellmann.com)

data/app/helpers/cryptofont/rails/icon_helper.rb

@@ -1,25 +1,20 @@
 module Cryptofont
   module Rails
     module IconHelper
-      # Creates an icon tag given an icon name and possible icon
-      # modifiers.
-      #
       # Examples
       #
       #   cf_icon "btc"
       #   # => <i class="cf-btc"></i>
       #
-      #   cf_icon "btc", text: "Bitcoin"
-      #   # => <i class="cf-btc"></i> Bitcoin
+      #   cf_icon "ltc", text: "Litecoin"
+      #   # => <i class="cf-litecoin"></i> Litecoin
       #
-      #   cf_icon "btc-right", text: "Bitcoin", right: true
-      #   # => Bitcoin <i class="cf-btc-right"></i>
+      #   cf_icon "eth", text: "Ethereum", right: true
+      #   # => Ethereum <i class="cf-eth"></i>
       #
-      #   cf_icon "btc", data: { id: 123 }
-      #   # => <i class="cf-btc" data-id="123"></i>
+      #   cf_icon "dash 4x", text: "Dash"
+      #   # => <i class="cf-dash cf-4x"></i>
       #
-      #   content_tag(:li, cf_icon("ltc li", text: "Bulleted list item"))
-      #   # => <li><i class="cf-ltc fa-li"></i> Bulleted list item</li>
       def cf_icon(names = 'flag', options = {})
         classes = []
         classes.concat Private.icon_names(names)

data/lib/cryptofont-rails/version.rb

@@ -1,5 +1,5 @@
 module Cryptofont
   module Rails
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptofont-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andre Antonov Frizbee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,11 +71,12 @@ files:
 - app/assets/fonts/cryptofont-webfont.svg
 - app/assets/fonts/cryptofont-webfont.ttf
 - app/assets/fonts/cryptofont-webfont.woff
-- app/assets/stylesheets/cryptofont.css.scss
+- app/assets/stylesheets/cryptofont.scss
 - app/helpers/cryptofont/rails/icon_helper.rb
 - bin/console
 - bin/setup
 - cryptofont-rails-0.1.0.gem
+- cryptofont-rails-0.1.1.gem
 - cryptofont-rails.gemspec
 - lib/cryptofont-rails.rb
 - lib/cryptofont-rails/engine.rb