Guide your users through a tour of your app
JavaScript CSS HTML
Latest commit 0dc484b Aug 14, 2018
Permalink
Failed to load latest commit information.
cypress Start on cypress (#209) Aug 14, 2018
docs/welcome [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
src [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
test Start on cypress (#209) Aug 14, 2018
.babelrc [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
.eslintignore Start on cypress (#209) Aug 14, 2018
.eslintrc.js increase test coverage (#206) Aug 13, 2018
.gitignore Start on cypress (#209) Aug 14, 2018
.npmignore ESLint tweaks Aug 1, 2018
.stylelintrc.js Move base style imports to _base Jul 9, 2018
.travis.yml [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
CHANGELOG.md Update changelog Jul 16, 2018
CONTRIBUTING.md [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
HISTORY.md Setup changelog generation Jul 7, 2018
LICENSE Update LICENSE Jul 9, 2018
README.md Add Code Climate badges Aug 1, 2018
_config.yml Add theme Jul 16, 2018
cypress.json Start on cypress (#209) Aug 14, 2018
index.md Merge pull request #192 from shipshapecode/render-location Jul 12, 2018
install.json update to set applyStyle as disabled and shepherd sets popper styles … Jul 2, 2018
karma.conf.js Fix coverage generation Aug 13, 2018
package.json 2.0.0-beta.16 Aug 14, 2018
postcss.config.js [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
webpack.config.js [feature/builder] - replace Gulp with module loader and npm (#203) Aug 7, 2018
yarn.lock Start on cypress (#209) Aug 14, 2018

README.md

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

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