README.md in font_awesome5_rails-0.1.0 vs README.md in font_awesome5_rails-0.2.0

- old
+ new

@@ -38,10 +38,37 @@ fa_icon('camera-retro', class: 'my-class', text: 'Camera', size: '3x') # => <i class="fas fa-camera-retro my-class fa-3x"></i> # => <span>Camera</span> ``` +### Solid, Regular, Light, Brand icon types +In Font Awesome 5 there are several different types of icons. In font_awesome5_rails gem default icon type is ```solid```. +If you want to use different icon style you can do this through ```type``` attribute. + +| Style | type: | +| ------------- |-------| +| Solid | :fas | +| Regular | :far | +| Light | :fal | +| Brand | :fab | + + +```ruby +fa_icon('camera-retro', type: :fas) +# => <i class="fas fa-camera-retro"></i> + +fa_icon('camera-retro', type: :far) +# => <i class="far fa-camera-retro"></i> + +fa_icon('camera-retro', type: :fal) +# => <i class="fal fa-camera-retro"></i> + +fa_icon('camera-retro', type: :fab) +# => <i class="fab fa-camera-retro"></i> + +``` + ### Animations and data attributes FontAwesome 5 provides new animations and data attributes. Here are some examples how to use them: ```ruby fa_icon('camera-retro', animation: 'spin') # => <i class="fas fa-camera-retro fa-spin"></i> @@ -53,5 +80,7 @@ More animation and data attributes can be found on [FontAwesome documentation](https://fontawesome.com/how-to-use/svg-with-js). ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). + +[Font Awesome5 License](https://fontawesome.com/license).