modified readme

Author: dee-me-tree-or-love

README.md

@@ -1,2 +1,40 @@
-# serverless-lambda-announcer
-A plugin for serverless framework that announces a deploy of a new function to a given url. 
+# serverless-lambda-announcer
+A plugin for serverless framework that announces a deploy of a new function to a given url. 
+
+## Purpose  
+This plugin allows to specify a custom hook listening for lambda deploys.  
+On deploy the announcer will announce the lambda definition to the specified hook. :speech_balloon:  
+The hook should be a `POST` endpoint accepting json-encoded payload.   
+## Installation  
+Run `npm install serverless-lambda-announcer`  
+Add it to the `serverless.yml` as:  
+```
+plugins:
+  ...
+  - serverless-lambda-announcer
+  ...
+```  
+## Usage  
+In the `serverless.yml` specify a custom parameter for the announcer:  
+```
+custom:
+  - announcer:
+      hook: <your POST webhook>
+```    
+The body that is sent from the announcer is:  
+```
+[
+  {
+    "endpoints": [
+      {
+        "method": <http method>,
+        "path": <full https endpoint>
+      }
+    ],
+    "name":"<service name> : <function name>",
+    "events":[
+      {<generated cloudformation event data>}
+    ]
+  }  
+]
+```  

package.json

@@ -1,26 +1,26 @@
-{
-  "name": "serverless-lambda-announcer",
-  "version": "1.0.0",
-  "description": "A plugin for serverless framework that announces a deploy of a new function to a given url.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dee-me-tree-or-love/serverless-lambda-announcer.git"
-  },
-  "author": "dmitrii",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/dee-me-tree-or-love/serverless-lambda-announcer/issues"
-  },
-  "homepage": "https://github.com/dee-me-tree-or-love/serverless-lambda-announcer#readme",
-  "dependencies": {
-    "request": "^2.85.0"
-  },
-  "devDependencies": {
-    "eslint": "^4.19.1",
-    "eslint-config-google": "^0.9.1"
-  }
-}
+{
+  "name": "serverless-lambda-announcer",
+  "version": "1.0.1",
+  "description": "A plugin for serverless framework that announces a deploy of a new function to a given url.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dee-me-tree-or-love/serverless-lambda-announcer.git"
+  },
+  "author": "dmitrii",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/dee-me-tree-or-love/serverless-lambda-announcer/issues"
+  },
+  "homepage": "https://github.com/dee-me-tree-or-love/serverless-lambda-announcer#readme",
+  "dependencies": {
+    "request": "^2.85.0"
+  },
+  "devDependencies": {
+    "eslint": "^4.19.1",
+    "eslint-config-google": "^0.9.1"
+  }
+}