mirrors/all-contributors-cli
1
0
Fork 0
mirror of https://github.com/all-contributors/cli.git synced 2025-01-10 05:56:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: change suggested scripts names (#63)

Browse source 
* Change script name and add yarn

The script name suggested (`add`) will conflict with users of yarn.

So I modified the suggested name to `append` which is what it does.  And now it can have a yarn example as well.

* remove yarn example

* namespace add
This commit is contained in:
Gant Laborde 2017-11-08 16:09:22 -06:00 committed by Kent C. Dodds
parent 82d1eb7c51
commit 9f875e9aa8
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -19,18 +19,19 @@ Once initialized, you don't need to have `all-contributors-cli` installed globa
```console ```console
npm install --save-dev all-contributors-cli npm install --save-dev all-contributors-cli
``` ```
```json ```json
{ {
"scripts": { "scripts": {
"add": "all-contributors add", "contributors:add": "all-contributors add",
"generate": "all-contributors generate" "contributors:generate": "all-contributors generate"
} }
} }
``` ```
and use them via `npm run`: and use them via `npm run`:
```console ```console
npm run add -- jfmengels doc npm run contributors:add -- jfmengels doc
npm run generate npm run contributors:generate
``` ```
## Usage ## Usage