diff --git a/.gitignore b/.gitignore index ef0bafdb9..9ac82954e 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ node_modules/ bower_components/ .DS_Store -.idea \ No newline at end of file +.idea +dist/ \ No newline at end of file diff --git a/docs/intro.md b/docs/intro.md index 582911e38..d7ff3725f 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -10,6 +10,18 @@ Guide your users through a tour of your app. [Popper](https://popper.js.org/) +### Install + +```bash +npm install shepherd.js --save +``` + +or + +```bash +yarn add shepherd.js +``` + ### Install with Eager The easiest way to add a Shepherd tour to your site is with [Eager](http://eager.io). @@ -165,7 +177,7 @@ when: { } } ``` -- `tetherOptions`: Extra options to pass to [tether](http://github.hubspot.com/tether) +- `popperOptions`: Extra options to pass to [popper.js](https://github.com/FezVrasta/popper.js) ##### Step Methods diff --git a/docs/welcome/coffee/welcome.coffee b/docs/welcome/coffee/welcome.coffee deleted file mode 100644 index e9aaabaab..000000000 --- a/docs/welcome/coffee/welcome.coffee +++ /dev/null @@ -1,68 +0,0 @@ -init = -> - setupShepherd() - -setupShepherd = -> - shepherd = new Shepherd.Tour - defaults: - classes: 'shepherd-element shepherd-open shepherd-theme-arrows' - showCancelLink: true - - shepherd.addStep 'welcome', - text: [ - 'Shepherd is a javascript library for guiding users through your app. It uses Tether, another open source library, to position all of its steps.', - 'Tether makes sure your steps never end up off screen or cropped by an overflow. Try resizing your browser to see what we mean.' - ] - attachTo: '.hero-welcome bottom' - classes: 'shepherd shepherd-open shepherd-theme-arrows shepherd-transparent-text' - buttons: [ - text: 'Exit' - classes: 'shepherd-button-secondary' - action: shepherd.cancel - , - text: 'Next' - action: shepherd.next - classes: 'shepherd-button-example-primary' - ] - - shepherd.addStep 'including', - title: 'Including' - text: 'Including Shepherd is easy! Just include shepherd.js, and a Shepherd theme file.' - attachTo: '.hero-including bottom' - buttons: [ - text: 'Back' - classes: 'shepherd-button-secondary' - action: shepherd.back - , - text: 'Next' - action: shepherd.next - ] - - shepherd.addStep 'example', - title: 'Example Shepherd' - text: 'Creating a Shepherd is easy too! Just create Shepherd and add as many steps as you want. Check out the documentation to learn more.' - attachTo: '.hero-example bottom' - buttons: [ - text: 'Back' - classes: 'shepherd-button-secondary' - action: shepherd.back - , - text: 'Next' - action: shepherd.next - ] - - shepherd.addStep 'followup', - title: 'Learn more' - text: 'Star Shepherd on Github so you remember it for your next project' - attachTo: '.hero-followup bottom' - buttons: [ - text: 'Back' - classes: 'shepherd-button-secondary' - action: shepherd.back - , - text: 'Done' - action: shepherd.next - ] - - shepherd.start() - -$ init