[doc] Split upcoming and finished roadmap

CHANGELOG.md

@@ -4,9 +4,13 @@
 
 [release](https://github.com/dyweb/gommon/releases/tag/0.0.8) [closed issues](https://github.com/dyweb/gommon/issues?q=is%3Aclosed+milestone%3A0.0.8)
 
+Breaking change in factory functions
+
 - reduce handler interface from 6 methods to 1
 - [#88](https://github.com/dyweb/gommon/issues/88) add benchmark
 - [#33](https://github.com/dyweb/gommon/issues/33) [#78](https://github.com/dyweb/gommon/issues/33) use log registry to keep tree of logger
+  - application logger is now application log registry
+  - library logger is now library log registry
 - escape string in json handler
 - [#87](https://github.com/dyweb/gommon/issues/87) add multi handler for fan out
 

README.md

@@ -17,9 +17,12 @@ It has the following components:
 - [generator](generator) Render go template, generate methods for logger interface based on `gommon.yml`
 - [log](log) A Javaish logger for Go, application can set level for their dependencies based on package, struct 
 - [noodle](noodle) Embed static assets for web application with `.noodleignore` support
-- [requests](requests) A pythonic wrapper for `net/http`, HTTP for Gopher
 - [structure](structure) Bring data structure like Set etc. to Golang
-- [util](util) A collection of utils
+- [util](util) small utils over standard libraries utils
+
+Deprecating
+
+- [requests](requests) A pythonic wrapper for `net/http`, HTTP for Gopher
 
 Legacy
 

ROADMAP.md

@@ -1,26 +1,33 @@
 # Roadmap
 
-## 0.0.8
+## Up coming
 
-- [x] test coverage for multiple packages
-- [x] tree of loggers in use
-- [x] benchmark against other loggers
-
-## 0.0.9
+### 0.0.9
 
 - [ ] more complex error interface, error code
 - [ ] organized error types
-- [ ] extension for collecting errors using third party services
 - [ ] explain internals of some implementation
 - [ ] start documenting the style for writing gommon itself, lib using gommon, app using gommon/lib using gommon
 - [ ] improve Makefile and dockerized build & test
 
-## 0.0.10
+Optional
+
+- [ ] extension for collecting errors using third party services
+
+### 0.0.10
 
 - [ ] support better logging for errors
 - [ ] init go mod support, not sure if it will be compatible with dep 
 
-## 0.0.11
+### 0.0.11
 
 - [ ] httputil package, merge part of current requests package unix domain sock etc.
-- [ ] requests, download and upload file, a curl like example
+- [ ] requests, download and upload file, a curl like example
+
+## Finished
+
+### 0.0.8
+
+- [x] test coverage for multiple packages
+- [x] tree of loggers in use
+- [x] benchmark against other loggers

log/README.md

@@ -1,5 +1,8 @@
 # Log
 
+- [Design](doc/design)
+- [Survey](doc/survey)
+
 ## Convention
 
 - library/application MUST have a library/application registry.

log/TODO.md

@@ -1,8 +1,10 @@
 # TODO
 
+This doc might be outdated, was mainly used to keep track when there is no wifi ...
+
 ## 2018-11-24
 
-- [ ] [#90](https://github.com/dyweb/gommon/pull/90) the long pending benchmark and refactor for adding context (fields to logger instance)
+- [x] [#90](https://github.com/dyweb/gommon/pull/90) the long pending benchmark and refactor for adding context (fields to logger instance)
 
 ## 2018-05-02
 

log/doc/README.md

@@ -1,5 +1,6 @@
 # gommon/log
 
+- [Design](design)
 - [Survey](survey)
 
 ## Goals

log/doc/backlog.md

@@ -1,10 +1,12 @@
 # Backlog
 
-Generate methods for struct that implement LoggableStruct interface
-
 Generate file line number to avoid the overhead of obtain them at runtime
 
 - https://github.com/WPH95/gosuger saw from Go Hackathon
 - https://www.onebigfluke.com/2014/12/generic-programming-go-generate.html
   - 850 stars, last updated 2016/01/07 https://github.com/clipperhouse/gen
-  - 532 starts, last updated 2017/03/28 https://github.com/cheekybits/genny
+  - 532 starts, last updated 2017/03/28 https://github.com/cheekybits/genny
+
+## Finished
+
+- Generate methods for struct that implement LoggableStruct interface

log/pkg.go

@@ -3,7 +3,7 @@ package log
 // LoggableStruct is used to inject a logger into the struct,
 // the methods for the interface can and should be generated using gommon.
 //
-// In struct initializer call dlog.NewStruct(pkgLogger, structInstancePointer)
+// In struct initializer call dlog.NewStructLogger(pkgLogger, structInstancePointer)
 type LoggableStruct interface {
 	GetLogger() *Logger
 	SetLogger(logger *Logger)