Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bcomnes committed Jan 15, 2017
1 parent bc0e6f5 commit 9cafd0a
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.png
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# level-auto-index change log

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## 1.0.0

* engage
* Initial release
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# level-auto-index

Automatic secondary indexing for leveldb compatable with subleveldown.
Automatic secondary indexing for leveldb and subleveldown.


```bash
Expand Down Expand Up @@ -125,3 +125,11 @@ function keyReducer (reducerString) {
```

For a higher level api for creating secondary indexes see [hypermodules/level-idx](https://github.com/hypermodules/level-idx).

## See Also

This module is a variant of

- [juliangruber/level-secondary](https://github.com/juliangruber/level-secondary)

but aimed at decoupling the index storage fromt the indexd db and also being compatable with subleveldown. It came out of the work trying to make `level-secondary` compatable with subleveldown and level-sublevel. That work lives here: [github.com/bcomnes/level-secondary/commit/9b2f914e53](https://github.com/bcomnes/level-secondary/commit/9b2f914e5304c791813b39abf892c32ee7616abf).

0 comments on commit 9cafd0a

Please sign in to comment.