From 3b8e98b6baf67d893ef1b7c95876acf0ee87343e Mon Sep 17 00:00:00 2001
From: Akvicor <akvicor@gmail.com>
Date: Sat, 11 Feb 2023 16:53:25 +0800
Subject: [PATCH] perfect README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..101fc49
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# glog
+
+自用的golang日志库
+
+# 类型
+
+使用`SetMask(m int)`设置每种消息是否输出
+
+- `Unknown(format string, values ...any)`: 写入`os.Stdout`
+- `Debug(format string, values ...any)`: 写入`os.Stdout`
+- `Trace(format string, values ...any)`: 写入`os.Stdout`
+- `Info(format string, values ...any)`: 写入`os.Stdout`
+- `Warning(format string, values ...any)`: 写入`os.Stdout`
+- `Error(format string, values ...any)`: 写入`os.Stderr`
+- `Fatal(format string, values ...any)`: 写入`os.Stderr`
+
+# 前缀
+
+支持添加时间、类型、调用位置，使用`SetFlag(f int)`设置前缀。
+
+# 文件
+
+支持在显示在控制台的同时写入文件，通过`SetLogFile(path string) error`设置文件，设置后会自动写入此文件。
+
+通过`CloseFile()`关闭文件，关闭后不再写入文件
+