Complete readme

GitbookIO · Nov 4, 2015 · ccccba3 · ccccba3
1 parent 5d92dc4
commit ccccba3
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/.foreman b/.foreman
diff --git a/Procfile b/Procfile
@@ -1 +1 @@
-web: node app/index.js
+web: node index.js
diff --git a/README.md b/README.md
@@ -1,4 +1,11 @@
-# services-slack
+# Slack Wbhook Service
 
-Slack notifications service for GitBook.
+This application is a simple webhook service for GitBook that post notifications to Slack.
+
+#### How to use it?
+
+1. Create an `incoming-webhook` integration in slack.
+2. You'll get an url like `https://hooks.slack.com/services/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`
+3. Create a webhook in your book with `https://slack-service.gitbook.com/hook/v1/T032H76MF/B0DR4R4US/SBdsOaiWfAfX57DNbgZ5wdIq`
+4. Done!
 
diff --git a/app/index.js → index.js b/app/index.js → index.js
@@ -27,6 +27,7 @@ app.post('/hook/v1/:tokens([\\/.\\w]*|)', gitbookMiddleware, function (req, res,
     slack.send({
         text: '<'+build.author.urls.profile+'|'+build.author.name+'> published a new update of <'+book.urls.access+'|'+book.title+'>',
         username: 'GitBook',
+        icon_url: 'https://www.gitbook.com/assets/images/logo/128.png'
     })
     .then(function() {
         res.send({ ok: true });

diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
         "express": "4.13.3",
         "lodash": "3.10.1",
         "q": "1.4.1",
-        "gitbook-webhook-middleware": "1.0.0",
+        "gitbook-webhook-middleware": "1.0.1",
         "node-slack": "0.0.7"
     },
     "repository": {
@@ -19,5 +19,8 @@
     "license": "Apache-2.0",
     "bugs": {
         "url": "https://github.com/GitbookIO/services-slack/issues"
+    },
+    "scripts": {
+        "start": "node ./index.js"
     }
 }