README.md in font_awesome5_rails-0.3.0 vs README.md in font_awesome5_rails-0.3.1
- old
+ new
@@ -1,22 +1,25 @@
-# FontAwesome5Rails
+# Font Awesome 5 Rails
[![Build Status](https://travis-ci.org/tomkra/font_awesome5_rails.svg?branch=master)](https://travis-ci.org/tomkra/font_awesome5_rails)
[![HitCount](http://hits.dwyl.io/tomkra/tomkra/font_awesome5_rails.svg)](http://hits.dwyl.io/tomkra/tomkra/font_awesome5_rails)
font_awesome5_rails provides the [Font-Awesome5](https://fontawesome.com/) web fonts, stylesheets and javascripts as a Rails engine for use with the asset pipeline and with backwards compatibility with [font-awesome-rails](https://github.com/bokmann/font-awesome-rails) gem.
This gem provides only Free icons from Font-Awesome.
+Keep track of changes in [Changelog](https://github.com/tomkra/font_awesome5_rails/blob/master/CHANGELOG.md).
+
## Table of Contents
**[Instalation](#instalation)** <br />
**[Usage](#usage)** <br />
- **[Basic usage](#basic-usage)** <br />
- **[Solid, Regular, Light, Brand icon types](#solid-regular-light-brand-icon-types)** <br />
- **[Animations and data attributes](#animations-and-data-attributes)** <br />
- **[Layered and Stacked icons](#layered-and-stacked-icons)** <br />
**[Use as images](#use-as-images)** <br />
+**[FontAwesome 5 Pro icons](#fontawesome-5-pro-icons)** <br />
## Installation
Now you have two options how to include FontAwesome 5 icons. First option is to use ```SVG``` and ```JS``` files which is recommended by FontAwesome team. However you can use icons as ```webfont with CSS``` but you will not be able to use new FA5 features as animations or ```layered_icons```. Choose one installation option from above:
@@ -178,9 +181,19 @@
```
More examples can be found in specs.
More animation and data attributes can be found on [FontAwesome documentation](https://fontawesome.com/how-to-use/svg-with-js).
+
+## FontAwesome 5 Pro icons
+Due to licence policy this gem pack only free FA5 icons. However ```fa_icon``` helper support all types of icons. If you buyed FA5 Pro icons and want to use helpers provided by this gem it's possible.
+1. Add this gem to your ```Gemfile``` without including anything to ```application.css``` and ```application.js```.
+2. Download your FA5 pro icons and unpack them.
+3. Now you will have to manualy include all FA5 files you want to use to your ```/assets``` folder.
+4. If you're using ```svg``` files do not forget to include ```*.svg``` in your ```assets.rb``` file.
+5. You should now be able to use all FA5 Pro icons with helpers provided by this gem.
+
+If you have any questions feel free to create new issue.
## 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).