From ae1ddbe26620a6ae62947841119e65f57ac5747a Mon Sep 17 00:00:00 2001
From: Nicolas Dextraze <nicolas.dextraze@dexdo.com>
Date: Wed, 16 Mar 2016 23:15:25 -0700
Subject: [PATCH] Update readme for NPM release

---
 README.md | 30 ++++++++++++++++++++----------
 1 file changed, 20 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 043fb85..c58922c 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,7 @@ A port of the EventStore .Net ClientAPI to Node.js
 ## Dependencies
 
 - Node.js >= 0.12
-- protobufjs module
-- uuid module
+- Modules: [long](https://www.npmjs.org/package/long), [protobufjs](https://www.npmjs.org/package/protobufjs), [uuid](https://www.npmjs.org/package/uuid) (installed via `npm install`)
 
 ## Status
 
@@ -22,7 +21,17 @@ Unstable
 - Typed errors: currently most errors are direct instance of Error, which is not practical for error handling
 - Performance: there's still some while loop in the code that could be problematic with node.js
 - Tests: tests are only covering happy path scenarios for now
-- NPM package: no package released yet, I will release one when code is stable
+
+## Getting started
+
+Install the client using npm
+
+    npm install eventstore-node
+    
+Examples
+
+    TODO
+
 
 ## Porting .Net Task to Node.js
 
@@ -38,11 +47,12 @@ I used Promise to replace .Net Task, so when executing an async command, i.e. ap
       });
 
 ## Running the tests
-You will need:
 
-- dependencies (`npm install`)
-- nodeunit (`npm install -g nodeunit`)
-- an instance of EventStore running on localhost:1113 (https://geteventstore.com/downloads/)
+To run the tests you will need
+
+- To install the dependencies (`npm install`)
+- To install nodeunit (`npm install -g nodeunit`)
+- Run an instance of EventStore >= 3.3.0 (competing consumers are required for test) on localhost:1113 (Download [here](https://geteventstore.com/downloads/))
 
 To execute the tests suites simply run test with npm
 
@@ -50,6 +60,6 @@ To execute the tests suites simply run test with npm
 
 ## License
 
-This is a port, original code is released under the EventStore license and can be found at https://github.com/eventstore/eventstore.
-
-Ported code is released under the MIT license, see https://github.com/nicdex/eventstore-node/blob/master/LICENSE
+Ported code is released under the MIT license, see [LICENSE](https://github.com/nicdex/eventstore-node/blob/master/LICENSE). 
+ 
+Original code is released under the EventStore license and can be found at https://github.com/eventstore/eventstore.