From 400f636a1d0f56f81987efed515900fc69127c3f Mon Sep 17 00:00:00 2001
From: Inhere <in.798@qq.com>
Date: Thu, 5 Jan 2023 01:03:20 +0800
Subject: [PATCH] :memo: doc: update readme add more usage examples

---
 README.md       | 9 +++++++++
 README.zh-CN.md | 7 ++++++-
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index db74501..74e4604 100644
--- a/README.md
+++ b/README.md
@@ -465,10 +465,15 @@ func main() {
 
 	// DangerLevels contains: slog.PanicLevel, slog.ErrorLevel, slog.WarnLevel
 	h1 := handler.MustFileHandler("/tmp/error.log", handler.WithLogLevels(slog.DangerLevels))
+	// custom log format
+	// f := h1.Formatter().(*slog.TextFormatter)
+	f := slog.AsTextFormatter(h1.Formatter())
+	f.SetTemplate("your template format\n")
 
 	// NormalLevels contains: slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel
 	h2 := handler.MustFileHandler("/tmp/info.log", handler.WithLogLevels(slog.NormalLevels))
 
+	// register handlers
 	slog.PushHandler(h1)
 	slog.PushHandler(h2)
 
@@ -524,6 +529,10 @@ This is config struct for create a Handler:
 type Config struct {
 	// Logfile for write logs
 	Logfile string `json:"logfile" yaml:"logfile"`
+	// LevelMode for filter log record. default LevelModeList
+	LevelMode uint8 `json:"level_mode" yaml:"level_mode"`
+	// Level value. use on LevelMode = LevelModeValue
+	Level slog.Level `json:"level" yaml:"level"`
 	// Levels for log record
 	Levels []slog.Level `json:"levels" yaml:"levels"`
 	// UseJSON for format logs
diff --git a/README.zh-CN.md b/README.zh-CN.md
index d0277a8..7e306a3 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -140,7 +140,7 @@ h.GetFormatter().(*slog.TextFormatter).SetTemplate(slog.NamedTemplate)
 
 ![](_example/images/console-color-log1.png)
 
-> 注意： `slog.TextFormatter` 使用模板字符串来格式化输出日志，因此新增字段输出需要同时调整模板。
+> 注意：`slog.TextFormatter` 使用模板字符串来格式化输出日志，因此新增字段输出需要同时调整模板。
 
 ### 使用JSON格式
 
@@ -464,10 +464,15 @@ func main() {
 
 	// DangerLevels 包含： slog.PanicLevel, slog.ErrorLevel, slog.WarnLevel
 	h1 := handler.MustFileHandler("/tmp/error.log", handler.WithLogLevels(slog.DangerLevels))
+	// 配置日志格式
+	// f := h1.Formatter().(*slog.TextFormatter)
+	f := slog.AsTextFormatter(h1.Formatter())
+	f.SetTemplate("your template format\n")
 
 	// NormalLevels 包含： slog.InfoLevel, slog.NoticeLevel, slog.DebugLevel, slog.TraceLevel
 	h2 := handler.MustFileHandler("/tmp/info.log", handler.WithLogLevels(slog.NormalLevels))
 
+	// 注册 handler 到 logger(调度器)
 	slog.PushHandler(h1)
 	slog.PushHandler(h2)