Skip to content

Commit

Permalink
Add installation tutorial, remove esdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
RobbieTheWagner committed Jul 13, 2019
1 parent b92391e commit 0b56917
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 527 deletions.
1 change: 0 additions & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ checks:
exclude_patterns:
- "dist/"
- "docs/"
- "esdoc/"
- "jsdoc-template/"
- "src/eager/"
- "**/node_modules/"
Expand Down
24 changes: 0 additions & 24 deletions .esdoc.js

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
/cypress/
/dist/
/docs/shepherd.js/
/esdoc/
/node_modules/
/test/unit/dist
/.DS_Store
Expand Down
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,9 @@ jobs:
script:
- yarn build
- yarn docs
- yarn esdoc
before_deploy:
- git add -f --all dist/
- git add -f --all docs/shepherd.js/
- git add -f --all esdoc/
deploy:
provider: pages
skip-cleanup: true
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ tour.start();
Documentation
----------------------------------------------------------

[API documentation](https://shipshapecode.github.io/shepherd/esdoc/)
[API documentation](https://shepherdjs.dev/docs/shepherd.js/4.0.0-beta.1/)

Demo
----------------------------------------------------------

[Demo](https://shipshapecode.github.io/shepherd/docs/welcome/)
[Demo](https://shepherdjs.dev/docs/welcome/)

Contributing
----------------------------------------------------------
Expand Down
20 changes: 20 additions & 0 deletions docs/tutorials/Installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### npm

```bash
npm install shepherd.js --save
```

### yarn

```bash
yarn add shepherd.js
```

### Install with Eager

**Note: Eager is now Cloudflare Apps and likely does not currently work.**

### GitHub Releases

Whenever we release a new version, the contents of the `dist` are uploaded
to the release in GitHub. You can find those assets [here](https://github.com/shipshapecode/shepherd/releases).
21 changes: 0 additions & 21 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,6 @@ Guide your users through a tour of your app.
| --------- | --------- | --------- | --------- |
| IE11, Edge| last 2 versions| last 2 versions| last 2 versions

### Install

__npm__
```bash
npm install shepherd.js --save
```

__yarn__
```bash
yarn add shepherd.js
```

### Install with Eager

**Note: Eager is now Cloudflare Apps and likely does not currently work.**

### Importing Shepherd into your app

#### Ember Apps
Expand All @@ -46,11 +30,6 @@ i.e.
import Shepherd from 'shepherd.js';
```

#### GitHub Releases

Whenever we release a new version, the contents of the `dist` are uploaded
to the release in GitHub. You can find those assets [here](https://github.com/shipshapecode/shepherd/releases).

### Usage

First create a new `Tour` instance for your tour:
Expand Down
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,6 @@
"cypress": "^3.4.0",
"cypress-plugin-tab": "^1.0.1",
"del": "^5.0.0",
"esdoc": "^1.1.0",
"esdoc-ecmascript-proposal-plugin": "^1.0.0",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^6.0.1",
"eslint-plugin-jest": "^22.7.2",
"eslint-plugin-ship-shape": "^0.6.0",
Expand Down
Loading

0 comments on commit 0b56917

Please sign in to comment.