font-awesome-sass 4.4.0 → 5.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c1d7532c3397d210f7bc9589a90d776ce1ee681
-  data.tar.gz: 4f941525ed2f428d7954c22af94a29404a044d14
+SHA256:
+  metadata.gz: cacaa1219aaab42112307e8a47641b7ebba8861d1c2ac00e93beefccd15a3b94
+  data.tar.gz: 3d848d1e5e78ea46eed168865cd82af8db729dce652dc178a7de75da444e4a38
 SHA512:
-  metadata.gz: 17d7803394599c081173319825767fad16bbe755260d0be99586e593204c273fae47e194a277b2c29148f2d3852b0102e88640762ee8210627592004572e736d
-  data.tar.gz: 2db4c922d0770f094fabed57869e2e77675551173da74f02063d26cedbd3ac523e65c5fbbf1660410d48273fa9e34c8fc6aa9a6dac8981f12707803300fad7ac
+  metadata.gz: 803c5abda6e911d06888a1d1271ab47b07264d26fd74cbe87a474810db83d9365eaf65bca34dedae86df3e2c8711843b6b90cd1f98586399d01c3e4f4f18f68a
+  data.tar.gz: 15ce0e427b37547a0b1a3a50bdf0c23c43de4b2ea3bd10a9f5d28ba4a8335f02e46b437f57a4e1c4b3f3885647ee48b9ea78f5c14e0dadd2445c209777967a5c

data/.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rbenv-gemsets

data/README.md

@@ -1,10 +1,22 @@
 # FontAwesome::Sass
 
-'font-awesome-sass' is a Sass-powered version of [FontAwesome](http://fortawesome.github.io/Font-Awesome/) for your Ruby projects and plays nicely with 
+[![Gem Version](https://badge.fury.io/rb/font-awesome-sass.svg)](https://badge.fury.io/rb/font-awesome-sass)
+
+'font-awesome-sass' is a Sass-powered version of [FontAwesome](http://fortawesome.github.io/Font-Awesome/) for your Ruby projects and plays nicely with
  Ruby on Rails, Compass, Sprockets, etc.
- 
+
  Refactored to support more Ruby environments with code and documentation humbly used from the excellent
- [bootstrap-sass](https://github.com/twbs/bootstrap-sass) project by the Bootstrap team 
+ [bootstrap-sass](https://github.com/twbs/bootstrap-sass) project by the Bootstrap team
+
+## Breaking Changes
+
+With the update to Font Awesome 5.x there are some breaking changes that will effect your use of this gem. Some of the changes include:
+
+  * Icon name changes
+  * New icons
+  * The use of an icon style (`solid`, `regular`, or `brands`)
+
+You can find more detailed information on these changes on our [Getting Started](https://fontawesome.com/get-started/web-fonts-with-css) guide, our [How to Use](https://fontawesome.com/how-to-use/web-fonts-with-css) guide, and our [Upgrading from Version 4](https://fontawesome.com/how-to-use/upgrading-from-4) guide.
 
 ## Installation
 
@@ -18,7 +30,7 @@ Please see the appropriate guide for your environment of choice:
 In your Gemfile include:
 
 ```ruby
-gem 'font-awesome-sass', '~> 4.4.0'
+gem 'font-awesome-sass', '~> 5.15.1'
 ```
 
 And then execute:
@@ -35,23 +47,31 @@ includes the sprockets assets helper Sass functions used for finding the proper
 @import "font-awesome";
 ```
 
+If `app/assets/stylesheets/application.css.scss` does not exist then rename `app/assets/stylesheets/application.css` and add the `@import` statements below the `*= require` statements but outside of the comment block.
+
 #### Rails Helper usage
 
+With Font Awesome 5.x you now need to select what style of icon you want to use. Font Awesome 5.x has 3 styles:
+
+  * solid (`fas`)
+  * regular (`far`)
+  * brands (`fab`)
+
 In your view:
 
 ```ruby
-icon('flag')
-# => <i class="fa fa-flag"></i>
+icon('fas', 'flag')
+# => <i class="fas fa-flag"></i>
 ```
 
 ```ruby
-icon('flag', class: 'strong')
-# => <i class="fa fa-flag strong"></i>
+icon('far', 'address-book', class: 'strong')
+# => <i class="far fa-address-book strong"></i>
 ```
 
 ```ruby
-icon('flag', 'Font Awesome', id: 'my-icon', class: 'strong')
-# => <i id="my-icon" class="fa fa-flag strong"></i> Font Awesome
+icon('fab', 'font-awesome', 'Font Awesome', id: 'my-icon', class: 'strong')
+# => <i id="my-icon" class="fab fa-font-awesome strong"></i> Font Awesome
 ```
 
 Note: the icon helper can take a hash of options that will be passed to the content_tag helper
@@ -78,18 +98,18 @@ Import the FontAwesome styles
 @import "font-awesome";
 ```
 
-## Upgrading from FontAwesome::Sass 3.x
+## Upgrading from FontAwesome::Sass 4.x
 
-Prepend the `fa` class to existing icons:
+Prepend the style of the icon you want to use (`fas`, `far`, `fab`) class to existing icons:
 
-3.x Syntax
+4.x Syntax
 
 ```html
-<i class="icon-github"></i>
+<i class="fa fa-github"></i>
 ```
 
-4.x Syntax
+5.x Syntax (GitHub icon exists in the Brands style)
 
 ```html
-<i class="fa fa-github"></i>
+<i class="fab fa-github"></i>
 ```