Hopscotch::Rails

Hopscotch is a framework for making product tours on web pages. This gem makes it easy to include the framework into a Rails app.

Installation

Add this line to your application's Gemfile:

gem 'hopscotch-rails', git: "https://github.com/xinspire/hopscotch-rails.git"

And then execute:

$ bundle

Or install it yourself as:

$ gem install hopscotch-rails

Usage

Require the assets:

In app/assets/javascripts/application.js:

//= require hopscotch

In app/assets/stylesheets/application.css:

*= require hopscotch

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request