Skip to content

pedroceles/shepherd

 
 

Repository files navigation

Shepherd

npm version Build Status

Guide your users through a tour of your app

Install

Dependencies

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

npm

$ npm install shepherd.js

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

MIT License

About

Guide your users through a tour of your app #hubspot-open-source

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 47.8%
  • JavaScript 45.3%
  • CoffeeScript 6.9%