https://github.com/jinhucheung/shepherdjs_rails

shepherdjs_rails wraps the Shepherd JavaScript library so that it can easily be included in Rails
https://github.com/jinhucheung/shepherdjs_rails

rails rails-engine shepherd tour

Last synced: 22 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jinhucheung/shepherdjs_rails
• Owner: jinhucheung
• License: mit
• Created: 2018-11-14T15:34:06.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-01T03:46:34.000Z (about 5 years ago)
• Last Synced: 2024-11-29T17:45:13.066Z (25 days ago)
• Topics: rails, rails-engine, shepherd, tour
• Language: Ruby
• Homepage: https://github.com/jinhucheung/shepherdjs_rails
• Size: 835 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# shepherdjs_rails

This gem wraps the [Shepherd](https://github.com/shipshapecode/shepherd) JavaScript library so that it can be included easily in the Rails asset pipeline.

## Installation

Add this line to your application's Gemfile:

```ruby

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](https://github.com/shipshapecode/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](https://opensource.org/licenses/MIT).