From 7159875fbd84ed35ee69bbf4d0dac74f82640af2 Mon Sep 17 00:00:00 2001
From: Anthony Moutte <instabledesign@gmail.com>
Date: Mon, 14 Oct 2019 15:48:11 +0200
Subject: [PATCH] update readme

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 58 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 3cad1b5..82615a2 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,27 @@ Gol4ng/Logger is another GO logger. The main line is to provide a friendly and f
 ## Quick Start
 
 ```go
-//TODO write example
+package main
+
+import (
+	"os"
+	"runtime"
+	
+	"github.com/gol4ng/logger"
+	"github.com/gol4ng/logger/formatter"
+	"github.com/gol4ng/logger/handler"
+)
+
+func main(){
+	// logger will print on STDOUT with default line format
+	l := logger.NewLogger(handler.Stream(os.Stdout, formatter.NewDefaultFormatter()))
+	
+	l.Debug("Go debug informations", logger.Ctx("go_os", runtime.GOOS).Add("go_arch", runtime.GOARCH))
+	// <debug> MyExample message {"go_arch":"amd64","go_os":"darwin"}
+	
+	l.Info("Another", nil)
+    //<info> Another
+}
 ```
 
 ## Logger interface
@@ -46,15 +66,49 @@ type LoggerInterface interface {
 
 ## Handlers
 
-The handler is the main part of the logger
+Handlers are log entry processor. It received a log entry and process it in order to send log to it's destination 
+
+Available handlers:
+- **stream** _it will write formatted log in io.Writer_
+- **socket** _it will write formatted log in net.Conn_
+- **chan** _send all entry in provided go channel_
+- **gelf** _format to gelf and send to gelf server (TCP or UDP gzipped chunk)_
+- **group** _it will send log to all provided child handlers_
+- **rotate** _it will write formatted log in file and rotate file (mode: interval/archive)_
+- **syslog** _send formatted log in syslog server_
 
 ## Formatters
 
-The formatter is ... 
+The formatter convert log entry to a string representation (text, json, gelf...)
+They are often inject in handler to do the conversion process
+
+Available formatters:
+- **default** `<info> My log message {"my_key":"my_value"}`
+- **line** _it's just a `fmt.Sprintf` facade_ format:`%s %s %s` will produce `My log message info <my_key:my_value>`
+- **gelf** _format log entry to gelf_ `{"version":"1.1","host":"my_fake_hostname","level":6,"timestamp":513216000.000,"short_message":"My log message","full_message":"<info> My log message [ <my key:my_value> ]","_my_key":"my_value"}`
+- **json** _format log entry to json_ `{"Message":"My log message","Level":6,"Context":{"my_key":"my_value"}}`
+
+## Middlewares
+
+The middleware are handler decorator/wrapper. It will allow you to do some process arround child handler 
+
+Available middleware:
+- **caller** _it will add caller file/line to context_ `<file:/my/example/path/file> <line:31>`
+- **context** _it permit to have a default context value_ usefull when you want to set global context value
+- **error** _it will print provided handler error_ (can be configure to silent it)
+- **filter** _it will permit to filter log entry_ level filter are available or you can use your own callback filter
+- **placeholder** _it will replace log message placeholder with contextual value_
+- **recover** _it will convert handler panic to error_
 
 ## Writers
 
-The writer is ... 
+Writers are use by handler to write/send log to appropriate destination
+
+Available writer:
+- **compress** _it will compress log to gzip/zlib_
+- **gelf_chunked** _it will chunked log entry into gelf chunk_
+- **rotate** _it will write in io.Writer and rotate writer on demand_
+- **time rotate** _it's a rotate writer that rorate with `time.Ticker`_
 
 ### Todo
 - benchmark
@@ -64,14 +118,9 @@ The writer is ...
     - websocket server 
     - socket server
     - https://craig.is/writing/chrome-logger
-    - rotating file
     - fingercross
-    - syslog
-    - syslog udp
     - grpc / protobuff
     - curl
-    - socket
-    - Gelf
     - Mail
     - Slack
     - hipchat
@@ -94,7 +143,6 @@ The writer is ...
     
 - Implement all the formatter
     - html
-    - gelf
     - proto
     - slack
     - flowdoc