An unofficial wrapper gem to distribute the free version of the FontAwesome icon library.

Please see that project for the original documentation on how to use FontAwesome in general. Continue below for details specific to using this gem in Ruby.

Install the gem and add to the application's Gemfile by executing:

$ bundle add font-awesome-free

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install font-awesome-free

Access the file path for assets by providing the technology type symbol to FontAwesome::Free[type], eg:

# Returns the absolute path to the Font Awesome css files directory.
FontAwesome::Free[:css]

You can also access the parent directory by using FontAwesome::Free:ROOT.

The gem's versioning will mirror the original library's. Any gem-specific version updates will be indicated by a fourth version number after patch. For example, compared to 1.0.0.0:

• 2.0.0.0 FontAwesome major change
• 1.1.0.0 FontAwesome minor change
• 1.0.1.0 FontAwesome patch change
• 1.0.0.1 Wrapper gem change

As the wrapper gem is intended to be as minimal as possible, it will not distinguish between major/minor/patch.

After checking out the repo, run:

bundle install 

To update the version of FontAwesome from Github, run:

bundle exec rake fa:update

To release a new version, update the version number in version.rb, and then run:

bundle exec rake release

which will:

1. create a git tag for the version,
2. push git commits and the created tag,
3. and push the .gem file to rubygems.org.

To install this gem onto your local machine, run:

bundle exec rake install

Bug reports and pull requests are welcome on GitHub at https://github.com/TenjinInc/font-awesome-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Contributions to the gem-specific files are welcome, but any changes to the original project should be directed there.

The gem is available as open source under the terms of the MIT License.

The original licence is available under its own licencing terms.

Everyone interacting in the gem project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the Code of Conduct.