From dc02ea2d5c9a1ca01af936b36993fb617d829b0f Mon Sep 17 00:00:00 2001 From: Louis Chatriot Date: Thu, 16 May 2013 17:54:43 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a36eb5..877ae37 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ Embedded persistent database for Node.js, with no dependency (except npm modules I needed to store data from another project (Braindead CI). I needed the datastore to be standalone (i.e. no dependency except other Node modules) so that people can install the software using a simple `npm install`. I couldn't find one without bugs and a clean API so I made this one. ## Installation, tests -It will be published as an npm module once it is finished. To launch tests: `npm test`. +```javascript +npm install nedb + +make test +``` ## API It's a subset of MongoDB's API (the most used operations). The current API will not change, but I will add operations as they are needed.