Update documentation

Author: zph

README.md

@@ -187,10 +187,16 @@ The generated file `moresql.json` will be in place ready for use.
 
 These features are part of mosql but not implemented in MoreSQL. PRs welcome.
 
-* Dot Notation for nested structures
 * extra_props field for spare data
-* Automatic creation of tables/columns
+* Automatic creation of tables/columns (we require explicit actions from users after providing guidance)
 
+## Dot notation
+
+We support dot notation for extracting nested objects from Mongo.
+
+`user.address` will perform a `(get_in map [:user :address])` type nested fetch.
+
+See gjson project for full syntax details: https://github.com/tidwall/gjson#path-syntax
 ## Performance
 
 During benchmarking when moresql is asked to replay existing events from oplog we've seen the following performance with the following configurations:

docs/README.template.md

@@ -129,10 +129,16 @@ The generated file `moresql.json` will be in place ready for use.
 
 These features are part of mosql but not implemented in MoreSQL. PRs welcome.
 
-* Dot Notation for nested structures
 * extra_props field for spare data
-* Automatic creation of tables/columns
+* Automatic creation of tables/columns (we require explicit actions from users after providing guidance)
 
+## Dot notation
+
+We support dot notation for extracting nested objects from Mongo.
+
+`user.address` will perform a `(get_in map [:user :address])` type nested fetch.
+
+See gjson project for full syntax details: https://github.com/tidwall/gjson#path-syntax
 ## Performance
 
 During benchmarking when moresql is asked to replay existing events from oplog we've seen the following performance with the following configurations:

docs/TODO.md

@@ -20,16 +20,15 @@ TO DEPLOY and RELEASE
 
 DESIRED
 ==
-* [ ] Use dot notation for config description of nested maps, ie allow for `get_in("outerkey", "innerkey")` as `outerkey.innerkey` by using https://github.com/tidwall/gjson
-* [ ] Improve library testing (unit and integration/system). Potentially using docker for full trip integration tests.
+* [x] Use dot notation for config description of nested maps, ie allow for `get_in("outerkey", "innerkey")` as `outerkey.innerkey` by using https://github.com/tidwall/gjson
 * [x] Refactor tail to have a producer/consumer as Read/Write
 * [x] Setup https://github.com/thejerf/suture wrappers on components
 * [x] Add testing and refactor to make each bit fairly decoupled
  * [x] Include docs and scripts to transition from mosql to moresql
 * [x] Setup formal worker pool along with overflow pool of workers
 * [x] add tracking mechanism for missing/broken tables beyond "log it into abyss".
 * [x] add error handling with rollbar/bugsnag/etc
-* [ ] Add persistance for oplog if desired by user via commandline flag
+* [ ] Improve library testing (unit and integration/system). Potentially using docker for full trip integration tests.
 
 
 SOMEDAYs
@@ -45,3 +44,4 @@ SOMEDAYs
  * [ ] Writers should fit the interface of accepting a pointer to tables struct and the channel of incoming operations
  * [ ] All of https://github.com/zph/moresql/blob/master/full_sync.go#L129-L136 should be inside the writer function as it will differ by output sink.
 * [ ] Support nested fetching ala `user.name` to extract 2 levels deep
+* [ ] Add persistance for oplog if desired by user via commandline flag