Update README/TODO

README.md

@@ -14,6 +14,7 @@ Here's the bullet list:
 - Operations-friendly "append-only" storage
   - allows you to backup live system
   - crash-recovery is very fast and the logic is straight forward
+  - All data subject to CRC32 checksums
 - Supports efficient range queries
   - Riak secondary indexing
   - Fast key and bucket listing
@@ -28,6 +29,19 @@ Here's the bullet list:
 Hanoi is developed by Trifork, a Riak expert solutions provider.  You're most
 welcome to contact us if you want help optimizing your Riak setup.
 
+### Configuration options
+
+Put these values in your `app.config` in the `hanoi` section
+
+```erlang
+ {hanoi, [
+          {data_root, "./data/hanoi"},
+          {compress, none | snappy | gzip},
+          {sync_strategy, none | sync | {seconds, N}},
+          {page_size, 32768}
+         ]},
+```
+
 ### How to deploy Hanoi as a Riak/KV backend
 
 This storage engine can function as an alternative backend for Basho's Riak/KV.

TODO

@@ -6,14 +6,14 @@
       file, e.g. [btree-nodes] [meta-data] [offset of meta-data]. This is written
       in hanoi_writer:flush_nodes, and read in hanoi_reader:open2.
   * test new snappy compression support
-  * Riak/KV secondary index (2i) support
-    * atomic multi-commit/recovery
   * support for time based expiry, merge should eliminate expired data
   * status and statistics
     * for each level {#merges, {merge-time-min, max, average}}
   * add @doc strings and and -spec's
   * check to make sure every error returns with a reason {error, Reason}
 
+  * clean up names, btree_range -> key_range, etc.
+
 * Phase 2: Production Ready
   * dual-nursery
   * cache for read-path