Skip to content
This repository has been archived by the owner on Mar 14, 2023. It is now read-only.

Commit

Permalink
docs(readme): improve install section (#186)
Browse files Browse the repository at this point in the history
Install shipit-cli globally instead of dev-dependency to be able to use it from the command line. Without installing it globally, `shipit` cannot be used as command line program.

shipit-deploy needs to be manually installed in the project for the examples below to work, else shipit will throw an error because it cannot find shipit-deploy.
  • Loading branch information
sceee authored and gregberge committed Apr 11, 2018
1 parent 5a09557 commit a764fff
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@
[![Star on GitHub][github-star-badge]][github-star]
[![Tweet][twitter-badge]][twitter]

## Install shipit command line tools and shipit-deploy in your project
```
npm install --save-dev shipit-cli
npm install --save-dev shipit-deploy
```

Shipit is an automation engine and a deployment tool.
Expand Down Expand Up @@ -50,9 +52,9 @@ module.exports = shipit => {
}
```

2. Run deploy command `shipit staging deploy`
2. Run deploy command using [npx](https://www.npmjs.com/package/npx): `npx shipit staging deploy`

3. You can rollback using `shipit staging rollback`
3. You can rollback using `npx shipit staging rollback`

## Recipes

Expand Down

0 comments on commit a764fff

Please sign in to comment.