From f32da096f2758c7754832dc61dae6a18072f5bee Mon Sep 17 00:00:00 2001 From: Louis Chatriot Date: Fri, 3 May 2013 19:29:29 +0300 Subject: [PATCH] Update README.md --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 49 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 443b07e..58ab9b9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,50 @@ -node-embedded-db -================ +# node-embedded-db -Couldn't find a good embedded datastore for node.js. I'm making one. +Embedded persistent database for Node.js, with no dependency (except npm modules of course). The API is the same as MongoDB. + +## Why? +I needed to store data from another project ([https://github.com/louischatriot/braindead-ci](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`. You + +## Performance +### Speed +Performance is pretty good on the kind of datasets it is designed for (10,000 documents or less). On my machine (3 years old, no SSD), with a collection with 10,000 documents: +* An insert takes 0.1ms +* A read takes 5.7ms +* An update takes 62ms +* A deletion takes 61ms +Read, update and deletion times are pretty much non impacted by the number of concerned documents. Inserts, updates and deletions are non-blocking. Read will be soon, too (but they are so fast it is not so important anyway). + +Memory + + +## API + + + +## License + +(The MIT License) + +Copyright (c) 2013 Louis Chatriot <louis.chatriot@gmail.com> + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.