From 9cafd0a24fed50b1960ccb7f59aea9810c4d8354 Mon Sep 17 00:00:00 2001 From: Bret Comnes Date: Sat, 14 Jan 2017 17:30:35 -0800 Subject: [PATCH] update readme --- .npmignore | 1 + CHANGELOG.md | 11 +++++++++++ README.md | 10 +++++++++- 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 .npmignore create mode 100644 CHANGELOG.md diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..e33609d --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ +*.png diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f983aa5 --- /dev/null +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 323516f..99ffa17 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # level-auto-index -Automatic secondary indexing for leveldb compatable with subleveldown. +Automatic secondary indexing for leveldb and subleveldown. ```bash @@ -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).