Update README.md

pull/2/head
Louis Chatriot 12 years ago
parent 1cf09144ba
commit dc02ea2d5c
  1. 6
      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 (<a href="https://github.com/louischatriot/braindead-ci" target="_blank">Braindead CI</a>). 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. I needed to store data from another project (<a href="https://github.com/louischatriot/braindead-ci" target="_blank">Braindead CI</a>). 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 ## 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 ## 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. 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.

Loading…
Cancel
Save