Update README.md

pull/2/head
Louis Chatriot 12 years ago
parent afe3bfa6d4
commit 2872a32cca
  1. 10
      README.md

@ -26,7 +26,16 @@ It's a subset of MongoDB's API (the most used operations). The current API will
* <a href="#indexing">Indexing</a> * <a href="#indexing">Indexing</a>
### Creating/loading a database ### Creating/loading a database
You can use NeDB as an in-memory only datastore or as a persistent datastore.
```javascript ```javascript
// In-memory only datastore
var Datastore = require('nedb')
, db = new Datastore(); // Call the constructor without any argument
// No need to call loadDatabase(), you can begin inserting data and query it right away
// Persistent datastore
var Datastore = require('nedb') var Datastore = require('nedb')
, db = new Datastore('path/to/datafile'); , db = new Datastore('path/to/datafile');
@ -34,6 +43,7 @@ db.loadDatabase(function (err) { // Callback is optional
// err is the error, if any // err is the error, if any
}); });
// Of course you can create multiple datastores if you need several // Of course you can create multiple datastores if you need several
// collections. For example: // collections. For example:
db = {}; db = {};

Loading…
Cancel
Save