Optimization code and update readme

.npmignore

@@ -1,3 +1,3 @@
 coverage
 demo
-test
+test

README.md

@@ -13,82 +13,124 @@ $ npm install timtam-logger
 
 ## API
 
-set logger options, default options: {"app": "timtam", "timestamp": true, "maxLength": 900}
+### constructor
+
+- `options` The options for logger, default: {"app": "timtam", "timestamp": true, "maxLength": 900, "level": 3}
 
 ```js
-const logger = require('timtam-logger');
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
+});
+```
 
-logger.set('app', 'timtam-test');
+### set
 
-logger.set({
-  app: 'timtam-test'
+Set the value for options
+
+- `k` The key of value or data to set
+
+- `v` The value
+
+```js
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
 });
 
+logger.set({
+  app: 'new-app',
+});
+logger.set('maxLength', 1000);
 ```
 
-### options
+### add
 
-- `app` the application name, default: `timtam'
+Add transport for logger
 
-- `timestamp` add timestamp to the log, default: `true`
+- `type` Transport type or uri for transport
 
-- `maxLength` the max length of the log, default: `1000`
-
-wrap an object for logger
+- `opts` The options for transport
 
 ```js
-const logger = require('timtam-logger');
-logger.wrap(console, ['info', 'log']);
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
+});
 
-// console.info === logger.info;
-console.info('Hello World!');
+logger.add('udp://127.0.0.1:5001');
+logger.add('console');
+logger.add('udp', {
+  host: '127.0.0.1',
+  port: 4012,
+});
 ```
 
-### object
+### remove
+
+Remove transport from logger
+
+- `transport` The transport
+
+```js
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
+});
 
-the object which add logger function
+const udpTransport = logger.add('udp://127.0.0.1:5001');
+logger.remove(udpTransport);
+logger.add('console');
+```
 
+### log info warn error debug
 
-add udp transport
+The log function for logger
 
 ```js
-const logger = require('timtam-logger');
-// logger.add(transportType, options);
-logger.add('udp', {
-  port: 6000,
-  host: '127.0.0.1'
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
 });
-// or use uri
-logger.add('udp://127.0.0.1:6000');
+logger.add('console');
+logger.info('my test');
 ```
 
+### wrap
 
-### transportType
+Wrap the function of target to use logger
 
-the transport type: `udp`, `console`
+- `target` The target to wrap 
+- `fns` The function to wrap, default is 'log', 'info', 'warn', 'error', 'debug'
 
-### options
+```js
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
+});
+logger.add('console');
 
-- `port` server port. Use in transport `udp` and `console`.
+logger.wrap(console);
+console.info('my test');
+```
 
-- `host` server host. Use in transport `udp`.
+### before after
 
+Use to insertBefore(insertAfter) some content to the log
 
-remove transport
+- `param` The insert message string or function to get the insert message
 
 ```js
-const logger = require('timtam-logger');
-const udpTransport = logger.add('udp', {
-  port: 6000,
-  host: '127.0.0.1'
+const Logger = require('timtam-logger');
+const logger = new Logger({
+  app: 'my-app',
 });
-setTimeout(function(){
-  logger.remove(udpTransport);
-}, 10 * 1000);
+logger.add('console');
+logger.after('--end');
+logger.after(() => '--start');
 ```
 
 
-
 ## License
 
 MIT