From 736692c21dcc1c1bc266b3ec274173a51c675475 Mon Sep 17 00:00:00 2001
From: dnomd343 <i@343.re>
Date: Tue, 2 Aug 2022 11:33:27 +0800
Subject: [PATCH] docs: update proxy description

---
 docs/Proxy.md       | 115 ++++++++++++++++++++++++++++++++++++++++++++
 docs/ProxyObject.md |  22 ---------
 2 files changed, 115 insertions(+), 22 deletions(-)
 create mode 100644 docs/Proxy.md
 delete mode 100644 docs/ProxyObject.md

diff --git a/docs/Proxy.md b/docs/Proxy.md
new file mode 100644
index 0000000..4ef50f3
--- /dev/null
+++ b/docs/Proxy.md
@@ -0,0 +1,115 @@
+# 代理节点格式
+
+## Shadowsocks
+
+```
+{
+    'type': 'ss',
+    'name': '...',
+    'info': ssObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [ssObject](./ProxyObject/Shadowsocks.md)：节点信息
+
+## ShadowsocksR
+
+```
+{
+    'type': 'ssr',
+    'name': '...',
+    'group': '...',
+    'info': ssrObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ group：节点群组（可选）
++ [ShadowsocksR](./ProxyObject/ShadowsocksR.md)：节点信息
+
+## VMess
+
+```
+{
+    'type': 'vmess',
+    'name': '...',
+    'info': vmessObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [vmessObject](./ProxyObject/VMess.md)：节点信息
+
+## VLESS
+
+```
+{
+    'type': 'vless',
+    'name': '...',
+    'info': vlessObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [vlessObject](./ProxyObject/VLESS.md)：节点信息
+
+## Trojan
+
+```
+{
+    'type': 'trojan',
+    'name': '...',
+    'info': trojanObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [trojanObject](./ProxyObject/Trojan.md)：节点信息
+
+## Trojan-Go
+
+```
+{
+    'type': 'trojan-go',
+    'name': '...',
+    'info': trojanGoObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [trojanGoObject](./ProxyObject/TrojanGo.md)：节点信息
+
+## Brook
+
+```
+{
+    'type': 'brook',
+    'name': '...',
+    'info': brookObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [brookObject](./ProxyObject/Brook.md)：节点信息
+
+## Hysteria
+
+```
+{
+    'type': 'hysteria',
+    'name': '...',
+    'info': hysteriaObject
+}
+```
+
++ type：节点类型
++ name：节点名称（可选）
++ [hysteriaObject](./ProxyObject/Hysteria.md)：节点信息
diff --git a/docs/ProxyObject.md b/docs/ProxyObject.md
deleted file mode 100644
index 7f33c84..0000000
--- a/docs/ProxyObject.md
+++ /dev/null
@@ -1,22 +0,0 @@
-# 代理节点格式
-
-```
-{
-    'type': ...,
-    ...
-}
-```
-
-**type**
-
-+ 类型：*str*
-+ 说明：节点类型
-+ 缺省：必选
-+ 可选值：`ss`,`ssr`,`vmess`,`vless`,`trojan`
-
-### [Shadowsocks](./ProxyObject/Shadowsocks.md)
-### [ShadowsocksR](./ProxyObject/ShadowsocksR.md)
-### [VMess](./ProxyObject/VMess.md)
-### [VLESS](./ProxyObject/VLESS.md)
-### [Trojan](./ProxyObject/Trojan.md)
-### [Trojan-Go](./ProxyObject/TrojanGo.md)