font_awesome5_rails 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ae01fb2d674f886da715d74b6ccf5b76ff15d98e4c99e241819850b959a390a
-  data.tar.gz: fe86b8718854d653dfb9506055fe8b8dee0051db1b87a4f23257bec1ff8c36de
+  metadata.gz: fecee3cc79b9de3bedb50d903468957302038d2be0b431d847e155f6b9d4a45e
+  data.tar.gz: e5b53f8a71fd2c55b540e9a5513544c812f728217efda6f1b7214417b321d53d
 SHA512:
-  metadata.gz: d92306ea361d08796a78ab70bcb2fad00a42e0b7662449132c70d4653b8f0d0f10a27ed87cc5cbe8a31d20ece6d093c3bda01fb72cbe58bcf6841d1ed771783b
-  data.tar.gz: 8a102d55529e46033c38e7ab9282527de84ccf4462b364376024a59fa6bb3acb70d39e12d4d6487970fc3f3f4aae34aea99eddbb104c609b6cc5258599fb6298
+  metadata.gz: 9c98549f9dc04db0efd05249bbc604b6a9452269a271085be62cb54baeb7bf9044a40b79dd5af31d0f3901f89439db1d9cc4f166f6edd6ef8365d2296b667f75
+  data.tar.gz: 1c735984cbe94da114bfe6608106c4266e07846c9ca556793b1df95bf9475878c5dbc4d81b3d39c78cb9415c151f216fca75167eb9f5e32159a6690a0cd5f816

data/README.md

@@ -6,7 +6,21 @@ font_awesome5_rails provides the [Font-Awesome5](https://fontawesome.com/) web f
 
 This gem provides only Free icons from Font-Awesome.
 
+## 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 />
+
+
 ## 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:
+
+### 1. Install as SVG with JS (recommended)
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -27,6 +41,12 @@ In your `application.js`, include the javascript file:
 #= require font_awesome5
 ```
 
+### 2. Install as webfont with CSS (old way)
+In your `application.css`, include the css file:
+```css
+ *= require font_awesome5_webfont
+```
+
 ## Usage
 Gem provides FontAwesome icons through helper. In your views just call `fa_icon`.
 
@@ -142,6 +162,14 @@ fa_stacked_icon('camera', base: 'circle', reverse: true, text: 'Text!') #Default
 
 ```
 
+## Use as images
+From version ```0.2.3``` you can include icons as images in your views.
+```ruby
+image_tag('fa5/solid/camera.svg')
+image_tag('fa5/brand/facebook.svg')
+image_tag('fa5/regular/bell.svg', width: '100px', class: 'my-img')
+```
+
 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).