simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): remove usage outside of npm scripts

Browse Source
This commit is contained in:
Stephan Bönnemann 2015-02-04 19:00:23 +01:00
parent f44cedbaa7
commit 73b888fdc3
1 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -8,12 +8,7 @@
```bash ```bash
npm i semantic-release npm i semantic-release
``` ```
You *need* to set it up inside your `package.json`:
`semantic-release` provides "prepublish" and "postpublish" hooks so you automatically release the correct version.
Run `semantic-release pre` right before `npm publish` and `semantic-release post` right after.
For maximum comfort you can automate this inside your `package.json`:
```json ```json
"scripts": { "scripts": {
@ -22,7 +17,7 @@ For maximum comfort you can automate this inside your `package.json`:
} }
``` ```
Note: Even though `semantic-release` works around a limitation in npm's "prepublish" hook using it prints an error that you can *safely ignore*. Note: `semantic-release` works around a limitation in npm's "prepublish" hook. Once a version is published it prints an error that you can *safely ignore*.
See [npm/npm#7118](https://github.com/npm/npm/issues/7118). See [npm/npm#7118](https://github.com/npm/npm/issues/7118).
MIT License MIT License