From 6be7ae9fb44c61cca03e57cae6dba71019c9a7e1 Mon Sep 17 00:00:00 2001
From: brettlangdon <brett@blangdon.com>
Date: Wed, 30 Oct 2013 20:14:59 -0400
Subject: [PATCH] update readme

---
 README.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 9611c86..17e8bd7 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,28 @@ node-wgdb
 
 Bindings for [WhiteDB](http://whitedb.org/) for [Node.JS](http://nodejs.org/).
 
-This is currently a work in progress and is not yet published to [npm](http://npmjs.org/).
+This library is still a work in progress and might not work for everyone.
+Please report any and all issues.
+
+## Installing
+You need to first install the [WhiteDB](http://whitedb.org/) library from their [download page](http://whitedb.org/download.html). The version developed against is `0.7.0`.
+
+### Via Git
+```bash
+git clone git://github.com/brettlangdon/node-wgdb.git
+cd ./node-wgdb
+npm install
+```
+
+### Via NPM
+```bash
+npm install wgdb
+```
 
 ## TODO
-* Need to add in locking
-* Need to finish flushing out the API
-* The C++ code really needs a decent refactor
-* Test might be a good idea
+* need to actually write documentation for it
+* API for setting fields could be a little better
+* the code could use some refactoring
 
 ## License
 ```