jinhucheung / shepherdjs_rails

shepherdjs_rails wraps the Shepherd JavaScript library so that it can easily be included in Rails

shepherdjs_rails

This gem wraps the Shepherd JavaScript library so that it can be included easily in the Rails asset pipeline.

Installation

Add this line to your application's Gemfile:

gem 'shepherdjs_rails'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install shepherdjs_rails

Usage

add shepherdjs_rails to your application.js manifest

//= require shepherd.min

Contributing

If you need a newer version of Shepherd:

1. Fork this repo.
2. Update the vendored files with the newest release of Shepherd
3. Update lib/shepherdjs_rails/version.rb to match the version of Shepherd that you updated to.
4. Push to your repo and create a pull request.

License

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