From 9f875e9aa8d4a84a83bf643a9cd555f36f0d82e0 Mon Sep 17 00:00:00 2001 From: Gant Laborde Date: Wed, 8 Nov 2017 16:09:22 -0600 Subject: [PATCH] doc: change suggested scripts names (#63) * 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 --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4fb4353..f79aaaa 100644 --- a/README.md +++ b/README.md @@ -19,18 +19,19 @@ Once initialized, you don't need to have `all-contributors-cli` installed globa ```console npm install --save-dev all-contributors-cli ``` + ```json { "scripts": { - "add": "all-contributors add", - "generate": "all-contributors generate" + "contributors:add": "all-contributors add", + "contributors:generate": "all-contributors generate" } } ``` and use them via `npm run`: ```console -npm run add -- jfmengels doc -npm run generate +npm run contributors:add -- jfmengels doc +npm run contributors:generate ``` ## Usage