improve defaultConsume and document.

README.md

@@ -17,7 +17,8 @@ const logging = require('toa-logging')
 const app = new Toa()
 app.use(logging())
 app.use(function () {
-  this.body = 'Hello!'
+  // logging middleware will add a Log instance to context.state
+  this.body = this.state.log
 })
 
 app.listen(3000)
@@ -31,7 +32,7 @@ const logging = require('toa-logging')
 
 ### logging([options])
 
-Create a new logging middleware function with `options`.
+Create a new logging middleware function with `options`. logging middleware will add a Log instance to `context.state`, you can append key/value to the log like `this.state.log.someKey = someValue`.
 
 #### options.skipper
 
@@ -48,18 +49,21 @@ logging({
 
 #### options.init
 
-Set a init function that will run at the begin, default to:
+Set a init function that will run at the begin. This function
+will be called as `init.call(context, context.state.log)`. Default to:
 
 ```js
 function defaultInit (log) {} // do nothing~
 ```
 
 #### options.consume
 
-Set a consume function that will run at the end, default to:
+Set a consume function that will run at the end. This function
+will be called as `consume.call(context, context.state.log)`. Default to:
 
 ```js
 function defaultConsume (log) {
+  log.status = this.status
   ilog.info(log) // write the log by ilog.info
 }
 ```

examples/simple.js

@@ -8,7 +8,8 @@ const logging = require('../index')
 const app = new Toa()
 app.use(logging())
 app.use(function () {
-  this.body = 'Hello!'
+  // logging middleware will add a Log instance to context.state
+  this.body = this.state.log
 })
 
 app.listen(3000)

index.js

@@ -43,6 +43,7 @@ function noOp () { return false }
 function defaultInit (log) {} // do nothing~
 
 function defaultConsume (log) {
+  log.status = this.status
   ilog.info(log) // write the log by ilog.info
 }
 

package.json

@@ -4,7 +4,7 @@
   "authors": [
     "Yan Qing <[email protected]>"
   ],
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "repository": {
     "type": "git",