Add start scripts and webhook info to examples

line · Dec 7, 2017 · 6b21aa8 · 6b21aa8
1 parent 4b8c772
commit 6b21aa8
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 7 deletions.
diff --git a/examples/echo-bot/README.md b/examples/echo-bot/README.md
@@ -4,22 +4,28 @@ An example LINE bot just to echo messages
 
 ## How to use
 
-Install deps:
+### Install deps
 
-```bash
+``` shell
 $ npm install
 ```
 
-Configuration:
+### Configuration
 
-``` bash
+``` shell
 $ export CHANNEL_SECRET=YOUR_CHANNEL_SECRET
 $ export CHANNEL_ACCESS_TOKEN=YOUR_CHANNEL_ACCESS_TOKEN
 $ export PORT=1234
 ```
 
-Run:
+### Run
 
-``` bash
+``` shell
 $ node .
 ```
+
+## Webhook URL
+
+```
+https://your.base.url/callback
+```
diff --git a/examples/echo-bot/index.js b/examples/echo-bot/index.js
@@ -18,7 +18,7 @@ const app = express();
 
 // register a webhook handler with middleware
 // about the middleware, please refer to doc
-app.post('/webhook', line.middleware(config), (req, res) => {
+app.post('/callback', line.middleware(config), (req, res) => {
   Promise
     .all(req.body.events.map(handleEvent))
     .then((result) => res.json(result));

diff --git a/examples/echo-bot/package.json b/examples/echo-bot/package.json
@@ -3,6 +3,9 @@
   "version": "0.0.0",
   "description": "An example LINE bot just to echo messages",
   "main": "index.js",
+  "scripts": {
+    "start": "node ."
+  },
   "dependencies": {
     "@line/bot-sdk": "^5.0.0",
     "express": "^4.15.2"

diff --git a/examples/kitchensink/README.md b/examples/kitchensink/README.md
@@ -27,3 +27,9 @@ export PORT=1234
 ``` shell
 node .
 ```
+
+## Webhook URL
+
+```
+https://your.base.url/callback
+```
diff --git a/examples/kitchensink/package.json b/examples/kitchensink/package.json
@@ -3,6 +3,9 @@
   "version": "0.0.0",
   "description": "A kitchen-sink LINE bot example",
   "main": "index.js",
+  "scripts": {
+    "start": "node ."
+  },
   "dependencies": {
     "@line/bot-sdk": "^5.0.0",
     "express": "^4.16.2"