README.md in font_awesome5_rails-0.4.0 vs README.md in font_awesome5_rails-0.4.1
- old
+ new
@@ -1,19 +1,19 @@
# Font Awesome 5 Rails
-[](https://badge.fury.io/rb/font_awesome5_rails)
-[](https://github.com/tomkra/font_awesome5_rails/blob/master/lib/font_awesome5_rails/version.rb)
+[](https://badge.fury.io/rb/font_awesome5_rails)
+[](https://github.com/tomkra/font_awesome5_rails/blob/master/lib/font_awesome5_rails/version.rb)
[](https://travis-ci.org/tomkra/font_awesome5_rails)
-[](http://hits.dwyl.io/tomkra/tomkra/font_awesome5_rails)
+[](http://hrits.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 />
+**[Installation](#installation)** <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 />
@@ -25,38 +25,38 @@
## 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:
Check ou the differences in [here](https://fontawesome.com/how-to-use/on-the-web/setup/getting-started?using=svg-with-js&explain=using).
-### 1. Install as SVG with JS
Add this line to your application's Gemfile:
```ruby
gem 'font_awesome5_rails'
```
+### 1. Install as webfont with CSS
In your `application.css`, include the css file:
```css
- *= require font_awesome5
+ *= require font_awesome5_webfont
```
or if you prefer scss add this to your `application.css.scss` file:
```sass
-@import 'font_awesome5';
+@import 'font_awesome5_webfont';
```
-In your `application.js`, include the javascript file:
-```javascript
-#= require font_awesome5
-```
-
-### 2. Install as webfont with CSS
+### 2. Install as SVG with JS
In your `application.css`, include the css file:
```css
- *= require font_awesome5_webfont.css
+ *= require font_awesome5
```
-or if you prefer scss add this to your `application.css.scss` file:
+or if you prefer scss add this to your `application.scss` file:
```sass
-@import 'font_awesome5_webfont.css';
+@import 'font_awesome5.css';
+```
+
+In your `application.js`, include the javascript file:
+```javascript
+#= require font_awesome5
```
## Usage
Gem provides FontAwesome icons through helper. In your views just call `fa_icon`.