From 2a60c7e737d9bd3e1d3122b7ea3e58d1daf0fa4e Mon Sep 17 00:00:00 2001
From: Ezra Obiwale <contact@ezraobiwale.com>
Date: Tue, 30 May 2017 15:05:15 +0100
Subject: [PATCH] Updated readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 548249a..9a7ce5b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# dpd-router-middleware
\ No newline at end of file
+Simple router middleware for deployd
+
+## Installation
+
+`npm install dpd-router-event dpd-router-middleware --save`
+
+## Usage
+
+app.js:
+
+      require('dpd-router-middleware')( require('deployd/lib/router'), 'global')  // <----- add this
+      try{
+        var deployd = require('deployd')
+        var dpd = deployd({port:3000});
+        dpd.listen();
+      }catch(e){
+        console.error(err.toString()) // becomes exception in analytics 
+      }
+
+**NOTE:** *global* as used above can be anything but must be the name of the router event resource;
+
+Now, open dashboard and create a `Router Event` with the name given above (*global* or whatever you put there)
\ No newline at end of file