From dc897d95e5be943877092117316012243b955bd8 Mon Sep 17 00:00:00 2001
From: GochoMugo <mugo@forfuture.co.ke>
Date: Sat, 18 Nov 2017 22:04:21 +0300
Subject: [PATCH] chore: Update npm script `gen-doc` to `doc`

---
 .github/PULL_REQUEST_TEMPLATE.md | 2 +-
 CONTRIBUTING.md                  | 4 +++-
 package.json                     | 3 ++-
 3 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index e35ebd9..adc2bcc 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,7 @@ For example, if your PR passes all tests, you would mark the option as so:
 Note the 'x' in between the square brackets '[]'
 -->
 - [ ] All tests pass
-- [ ] I have run `npm run gen-doc`
+- [ ] I have run `npm run doc`
 
 ### Description
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 343e6c7..ab5b29f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,13 +24,15 @@ Before proceeding any further, read the following documents:
 Run:
 
 ```bash
-$ npm run gen-doc
+$ npm run doc
 ```
 
+
 ### Running tests
 
 Please read `test/README.md` for more information.
 
+
 ### Transpiling ES2015 for older Node.js versions
 
 We use babel to transpile the code:
diff --git a/package.json b/package.json
index f1924ca..dcd12ad 100644
--- a/package.json
+++ b/package.json
@@ -14,7 +14,8 @@
     "bot"
   ],
   "scripts": {
-    "gen-doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md",
+    "gen-doc": "echo 'WARNING: `npm run gen-doc` is deprecated. Use `npm run doc` instead.' && npm run doc",
+    "doc": "jsdoc2md --files src/telegram.js --template doc/api.hbs > doc/api.md",
     "build": "babel -d ./lib src",
     "prepublish": "npm run build && npm run gen-doc",
     "eslint": "eslint ./src ./test ./examples",