docs: update README

README.md

@@ -1,14 +1,14 @@
 ### 🧩 VSCode 插件
 
-VS Code 扩展商店搜索 `Meta JSON Schema` 或 `ClashMeta.meta-json-schema`，安装扩展后即可获取 `Clash.Meta`的语法支持。
+VS Code 扩展商店搜索 `Meta JSON Schema` 或 `ClashMeta.meta-json-schema` ，安装扩展后即可获取 `Clash.Meta` 的语法支持。
 
 ## 💡 用法
 
 <details>
 <summary>Visual Studio Code中使用</summary>
 
-1. 安装YAML语法支持插件`redhat.vscode-yaml`。
-2. 在`.vscode`目录下的`settings.json`文件中（如不存在则手动创建），填入以下内容。其中，key为schema文件的地址，value为路径通配符，请根据需求自行修改。
+1. 安装YAML语法支持插件 `redhat.vscode-yaml` 。
+2. 在 `.vscode` 目录下的 `settings.json` 文件中（如不存在则手动创建），填入以下内容。其中，key为schema文件的地址(url或本地文件)，value为路径通配符，请根据需求自行修改。
    ```json
    {
      "yaml.schemas": {
@@ -21,22 +21,22 @@ VS Code 扩展商店搜索 `Meta JSON Schema` 或 `ClashMeta.meta-json-schema`
 <details>
 <summary>Monaco Editor中使用</summary>
 
-1.  安装`monaco-editor`（编辑器）和`monaco-yaml`（YAML支持）。
+1.  安装 `monaco-editor` （编辑器）和 `monaco-yaml` （YAML支持）。
 
     ```
     npm install monaco-editor
     npm install monaco-yaml
     ```
 
-2.  如果是vite项目，可通过安装插件简化初始化（其他构建工具如`webpack`请参考[monaco-yaml文档](https://github.com/remcohaszing/monaco-yaml?tab=readme-ov-file#using-monaco-webpack-loader-plugin)）。
+2.  如果是vite项目，可通过安装插件简化初始化（其他构建工具如 `webpack` 请参考[monaco-yaml文档](https://github.com/remcohaszing/monaco-yaml?tab=readme-ov-file#using-monaco-webpack-loader-plugin)）。
 
-    1.  安装`vite-plugin-monaco-editor`。
+    1.  安装 `vite-plugin-monaco-editor` 。
 
     ```
     npm install vite-plugin-monaco-editor
     ```
 
-    2.  配置`vite.config.ts`。
+    2.  配置 `vite.config.ts` 。
 
     ```javascript
     import { defineConfig } from "vite";
@@ -57,7 +57,7 @@ VS Code 扩展商店搜索 `Meta JSON Schema` 或 `ClashMeta.meta-json-schema`
     });
     ```
 
-    3.  代码中配置schema（请根据需求自行修改`fileMatch`）。
+    3.  代码中配置schema（请根据需求自行修改 `fileMatch` ）。
 
     ```javascript
     import * as monaco from "monaco-editor";
@@ -85,52 +85,56 @@ VS Code 扩展商店搜索 `Meta JSON Schema` 或 `ClashMeta.meta-json-schema`
 
 - <a href="https://dongchengjie.github.io/meta-json-schema/?schema=https://raw.githubusercontent.com/dongchengjie/meta-json-schema/main/schemas/clash-nyanpasu-merge-json-schema.json" target="_blank">clash-nyanpasu-merge-json-schema</a>
 
-## 🖥️ 开发
+## 🖥️ 贡献代码
 
-1.  下载代码
+1. Fork仓库代码
 
-```bash
-git clone https://github.com/dongchengjie/meta-json-schema.git
-```
-
-2.  使用Visual Studio Code打开项目（工作目录为.vscode所在目录）。
+2. 使用Visual Studio Code打开项目（工作目录为.vscode所在目录）
 
 ```bash
-code /path/to/project/location
+code path/to/project
 ```
 
 > [!NOTE]
-> 项目打开后会弹出建议安装YAML插件的提示,请点击确认安装或手动安装,以获取良好的开发体验。
+> 项目打开后会弹出建议安装YAML插件的提示，请点击确认安装或手动安装，以获取良好的开发体验。
 
-3.  安装依赖
+3. 安装依赖
 
 ```bash
 pnpm install
 ```
 
-4.  启动项目。执行下列命令后,会对`src`目录进行监视,如果发生变动则会对项目进行bundle,输出到`schemas`目录下。
+4. 启动项目。
+
+- 执行下列命令后，会对 `src` 目录进行监视。
+- 如果发生变动则会对项目进行打包，输出到 `schemas` 目录下。
 
 ```bash
 pnpm dev
 ```
 
-5.  测试schema。由于`.vscode`目录下`settings.json`中已事先配置了如下配置（`test`目录下的文件使用`schemas`目录下输出的schema文件）。因此可以对`src`进行修改,并在`test`目录下新增测试文件,及时观察变动并做出修正。
+5. 测试验证生成的schema文件
+
+- 由于 `.vscode` 目录下 `settings.json` 中已事先配置了如下配置（ `test` 目录下的文件使用 `schemas` 目录下输出的schema文件）。于是可以对`src`目录中的内容进行修改，通过自动打包更新schema文件。
+- 通过在 `test` 目录下新增测试文件，观察并验证校验结果，并及时做出修正。
 
 ```json
 "yaml.schemas": {
   "schemas/meta-json-schema.json": "test/clash-meta/**/*.yaml",
   "schemas/clash-verge-merge-json-schema.json": "test/clash-verge/**/*.yaml",
   "schemas/clash-verge-nyanpasu-json-schema.json": "test/clash-nyanpasu/**/*.yaml"
-},
+}
 ```
 
-6.  发布release。执行下列命令后,会根据`package.json`文件中定义的`releases`进行输出,并根据`optimization`决定是否进行压缩。
+6. 输出打包
+
+- 执行下列命令后，会根据 `package.json` 文件中定义的`releases`进行输出，并根据 `optimization` 决定是否进行压缩。
 
 ```bash
 pnpm release
 ```
 
-## 📚 语法参考
+## 📖 JSON Schema 语法参考
 
 <details>
 <summary>JSON Schema标准语法</summary>
@@ -142,15 +146,15 @@ pnpm release
 <details>
 <summary>Monaco Editor扩展语法</summary>
 
-> Monaco 编辑器是为 VS Code 提供支持的开源代码编辑器，使用下列属性提供更丰富的`Snippet`支持。
+> Monaco 编辑器是为 VS Code 提供支持的开源代码编辑器，使用下列属性提供更丰富的 `Snippet` 支持。
 
 ```typescript
 interface JSONSchema {
   // 自定义Snippet建议(数组)
   defaultSnippets?: {
     label: string; // 标签文本(索引)
     description?: string; // 标签描述(需要点击展开)
-    markdownDescription?: string; // 标签描述(需要点击展开，markdown格式，优先级高于description,)
+    markdownDescription?: string; // 标签描述(需要点击展开，markdown格式，优先级高于description)
     body: any; // 实际取值内容
     bodyText?: string; // 实际取值内容文本(暂无作用)
   }[];
@@ -169,12 +173,14 @@ interface JSONSchema {
 
 </details>
 
-## 🤔 FAQ
+## ❓ FAQ
+
+### definitions目录下的 `compatible.json` 文件的用途是什么？
 
-### definitions中的`compatible.json`文件的用途是什么？
+YAML支持 `Folded Style` 和 `Inline Style` 的写法。
+使用`"type": "boolean"`来定义某个属性，那么`'true'`和`'false'`就会提示`Incorrect type. Expected "boolean".`。
 
-YAML支持`Folded Style`和`Inline Style`的写法。
-使用`"type": "boolean"`来定义某个属性,那么`'true'`和`'false'`就会提示`Incorrect type. Expected "boolean".`。因此引入compatible类型,以兼容多种编码风格。
+因此引入compatible类型，以兼容多种编码风格。
 
 <details>
 <summary>Inline Style</summary>
@@ -205,4 +211,4 @@ proxies:
 </details>
 
 > [!NOTE]
-> 由于这种情况多发生于`proxies`配置部分，所以目前仅`proxies`配置中使用了`compatible.json`,其余地方可视情况使用。
+> 由于这种情况多发生于 `proxies` 配置部分，所以目前仅 `proxies` 配置中使用了 `compatible.json` ，其余地方可视情况使用。