From 6e3450fef29f07bca93c2fbe763cbd4f0bf7516f Mon Sep 17 00:00:00 2001
From: Jack <3486688394@qq.com>
Date: Tue, 21 Jan 2025 19:15:49 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BD=BF=E7=94=A8?=
 =?UTF-8?q?=E6=96=B9=E6=B3=95=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Readme.MD | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/Readme.MD b/Readme.MD
index acdeee2..4ee1ec3 100644
--- a/Readme.MD
+++ b/Readme.MD
@@ -1,3 +1,49 @@
 # JackCraft.Config
 
-一个自己觉得怎么好用怎么写的配置文件库
\ No newline at end of file
+一个自己觉得怎么好用怎么写的配置文件库
+
+## 使用方法
+
+### 获取配置文件
+
+> 配置文件不存在时会自动创建一个空 Json 文件，但是若配置文件不是 Json 标准格式将会在写入和读取键值时抛出异常
+
+```csharp
+// 标准示例: var config = new Config(new FileInfo(配置文件路径));
+var config = new Config(new FileInfo("./config.json"));
+```
+
+### 读取键值
+
+> 若键不存在则返回默认值，并且同时也会写入键值（若没有提供默认值则写入空）
+
+```csharp
+// 标准示例: var value = config.Get<T>(键, <可选>默认值);
+
+//  {
+//      "114514": "1919810"
+//  }
+var value = config.Get("114514", "1919810");
+var value = config.Get<string>("114514");
+
+//  {
+//      "abc": {
+//          "def": 1234
+//      }
+//  }
+var value = config.Get("abc.def", 1234);
+var value = config.Get<int>("abc.def");
+```
+
+### 写入键值
+
+```csharp
+// 标准示例: config.Set<T>(键, 值);
+
+//  {
+//      "114514": "1919810"
+//  }
+config.Set("114514", "1919810");
+
+// 其他类型与 Get<T> 同理...
+```