Guide your users through a tour of your app #hubspot-open-source
CSS JavaScript CoffeeScript
Latest commit 3bff2f1 Dec 9, 2016 @zackbloom zackbloom committed on GitHub Update README.md

README.md

Shepherd

GitHub
version

Guide your users through a tour of your app

Install

Dependencies

Installing via npm and bower will bring in the above dependencies as well.

npm

$ npm install tether-shepherd

bower

$ bower install tether-shepherd

Usage

let tour = new Shepherd.Tour({
  defaults: {
    classes: 'shepherd-theme-arrows'
  }
});

tour.addStep('example', {
  title: 'Example Shepherd',
  text: 'Creating a Shepherd is easy too! Just create ...',
  attachTo: '.hero-example bottom',
  advanceOn: '.docs-link click'
});

tour.start();

API documentation

Demo

Contributing

We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.

License

Copyright © 2015 HubSpot - MIT License