# tether-shepherd

> Guide your users through a tour of your app.

Latest version **1.8.1** (published 2016-09-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tether-shepherd
pnpm add tether-shepherd
yarn add tether-shepherd
bun add tether-shepherd
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.8.1 |
| Published | 2016-09-21 |
| First published | 2015-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/tether-shepherd) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | also, geoffdaigle, hs, timmfin |

## Links

- npm: https://www.npmjs.com/package/tether-shepherd
- npm.io page: https://npm.io/package/tether-shepherd

## Dependencies (1)

- [tether](https://npm.io/package/tether.md) ^1.0.1

## Recent versions

- 1.8.1 (latest) — 2016-09-21
- 1.8.0 — 2016-07-08
- 1.7.0 — 2016-02-10
- 1.6.2 — 2016-02-05
- 1.6.0 — 2016-02-05
- 1.2.0 — 2015-09-24
- 1.1.3 — 2015-06-17
- 1.1.2 — 2015-06-17
- 1.1.1 — 2015-06-08
- 1.1.0 — 2015-06-07
- 1.0.2 — 2015-05-27
- 1.0.1 — 2015-05-22
- 1.0.0 — 2015-05-20
- 0.7.2 — 2015-05-15

## README

## Shepherd

[![GitHub
version](https://badge.fury.io/gh/HubSpot%2Fshepherd.svg)](http://badge.fury.io/gh/HubSpot%2Fshepherd)


[![Guide your users through a tour of your app](http://i.imgur.com/LDhfBvd.png)](http://github.hubspot.com/shepherd/docs/welcome)


## Install

__Dependencies__

* __[Tether](https://github.com/HubSpot/tether)__

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


__npm__
```sh
$ npm install tether-shepherd
```

__bower__
```sh
$ bower install tether-shepherd
```

__Eager__

The easiest way to add a Shepherd tour to your site is with [Eager](http://eager.io).
Click Install to create a tour right on your site with no coding required.

<a href="https://eager.io/app/AalP5veMma6s/install?source=button">
  <img src="https://install.eager.io/install-button.png" border="0" width="126">
</a>


## Usage

```javascript
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](http://github.hubspot.com/shepherd/)

[Demo](http://github.hubspot.com/shepherd/docs/welcome/)


## Contributing

We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).


## License
Copyright &copy; 2015 HubSpot - [MIT License](LICENSE)

---
_Source: https://npm.io/package/tether-shepherd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
