Skip to content

Commit

Permalink
updated documentation and version for release
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmartins committed Sep 20, 2015
1 parent 188215a commit f3b001e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@

# README

JSON FileSystem Database is a JSON database such as MongoDB backed by IO FileSystem operations.<br/>
JSON FileSystem Database is a JSON database such as MongoDB backed by FileSystem IO.<br/>
Implemented with **Pessimistic Transaction Locking** approach.<br/>
All methods are asynchronous and access / filtering is executed in parallel using [async](https://github.com/caolan/async).<br/>
All methods are asynchronous and accessing / filtering is executed in parallel using [async](https://github.com/caolan/async).<br/>
Based on [Jalalhejazi](https://github.com/Jalalhejazi), [jsonfs](https://github.com/Jalalhejazi/jsonfs).

# Dependencies
Expand Down Expand Up @@ -66,6 +66,16 @@ var database,
});
```

# Options

```javascript
var Driver = new JSONDBFS({path: '/path/to/store/collections', inMemory: true});
...
database.Collection.update(criteria, updateCriteria, {upsert: false, multi: true}, callback);
```

Please check the implementation ands tests for more details.

# License

Apache License, Version 2.0
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "jsondbfs",
"description": "JSON Filesystem Database.",
"author": "Manuel Martins <[email protected]>",
"version": "0.0.2",
"version": "0.0.3",
"license": "Apache-2.0",
"engine": "node >= 0.12.0",
"main": "./index",
Expand Down

0 comments on commit f3b001e

Please sign in to comment.