Skip to content

bimone/shepherd

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shepherd

Ship Shape

Shepherd is maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project.

npm version Build Status Maintainability Test Coverage Greenkeeper badge

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 --save

yarn

yarn add 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

Packages

No packages published

Languages

  • JavaScript 85.7%
  • CSS 11.2%
  • HTML 3.1%