Contents

# Hopskip

[![Code Climate](https://codeclimate.com/github/boxuk/hopskip.png)](https://codeclimate.com/github/boxuk/hopskip)
[![Build Status](https://travis-ci.org/boxuk/hopskip.png?branch=master)](https://travis-ci.org/boxuk/hopskip)

Write [hopscotch](https://github.com/linkedin/hopscotch) introductions simply by adding YAML files to your Rails application.

## Install

Add `hopskip` to your `Gemfile`

    gem 'hopskip'

Add the `hopskip` template to your application layout. It doesn't matter where, as long as `controller` is the controller object currently visible to the user.

    <%= Hopskip::HopscotchParser.new(controller).show %>

## Usage

`hopskip` assumes a file structure like this:

    ├── app
      ├── tours
        ├── dashboards_tour.yml
        └── projects_tour.yml

Where each file is name `xyz_tour.yml` where `x` is the name of the controller.

The contents of each of these files should look similar to this:

    ---
    index:
      steps:
        - title: Welcome to My App
          content: "Some Text..."
          target: left_util
          placement: right

        - title: Dashboard
          content: "This is your dashboard"
          target: left_util
          placement: bottom
    show:
      steps:
        - title: another title...
      #...

You can generate an example tour file by using the included generator:

    rails generate tour [controller_name]

For a full list of params, check out the hopscotch docs.

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
hopskip-0.1.2	README.md
hopskip-0.1.1	README.md
hopskip-0.1	README.md