From aaed99f27e10685018ce32340cf7e6c83a92ae45 Mon Sep 17 00:00:00 2001 From: Louis Chatriot Date: Sat, 13 Jul 2013 19:00:41 +0200 Subject: [PATCH] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f4792d..ea08338 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ can be used with a simple `require` statement. The API is a subset of MongoDB's. NeDB is not intended to be a replacement of large-scale databases such as MongoDB! Its goal is to provide you with a clean and easy way to query data and persist it to disk, for web applications that do not need lots of concurrent connections, for example a continuous integration and deployment server and desktop applications built with Node Webkit. -I recently benchmarked NeDB against the popular client-side database TaffyDB and NeDB is much, much faster, so I will port it to browsers. Please comment on this issue if you have any ideas/requirements. +I recently benchmarked NeDB against the popular client-side database TaffyDB and NeDB is much, much faster. That's why I created a browser version. Check the change log in the wiki if you think nedb doesn't behaves as the documentation describes! Most of the issues I get are due to non-latest version NeDBs. @@ -401,6 +401,11 @@ db.insert({ somefield: 'nedb' }, function (err) { **Note:** the `ensureIndex` function creates the index synchronously, so it's best to use it at application startup. It's quite fast so it doesn't increase startup time much (35 ms for a collection containing 10,000 documents). +## Browser version +As of v0.8.0, you can use NeDB in the browser! You can find it and its minified version in the repository, in the `browser-version/out` directory. You can also build it from the sources if you want, the build script is `browser-version/build.js`. + +**The browser version is still young!** For now you can only use it as an in-memory database in browser environments, I'll implement persistence using indexeddb and localstorage later. Also, I've only tested it in Chrome yet, I may need to change the code a bit to have better browser support. + ## Performance ### Speed