Skip to content

Commit

Permalink
Update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
RobbieTheWagner committed Jul 3, 2018
1 parent ac850b1 commit 7f87faa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 70 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
node_modules/
bower_components/
.DS_Store
.idea
.idea
dist/
14 changes: 13 additions & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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

Expand Down
68 changes: 0 additions & 68 deletions docs/welcome/coffee/welcome.coffee

This file was deleted.

0 comments on commit 7f87faa

Please sign in to comment.