From 5040779fbc064ea8ba0acbe8f5ae5c2afe2d81df Mon Sep 17 00:00:00 2001
From: dnomd343 <i@343.re>
Date: Sun, 7 Aug 2022 11:17:52 +0800
Subject: [PATCH] docs: add README.md

---
 README.md                        | 42 ++++++++++++++++++++++++++++++++
 docs/ProxyObject/ShadowsocksR.md |  4 +--
 2 files changed, 44 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..02e1120
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# ProxyC
+
+> 强大的代理工具集，支持几乎所有科学上网协议
+
+✅完整的协议与选项支持：
+
++ `Shadowsocks`：支持[69种](./docs/ProxyObject/Shadowsocks.md#method)加密方式，[12种](./docs/ProxyObject/Shadowsocks.md#type)SIP003插件
+
++ `ShadowsocksR`：支持[37种](./docs/ProxyObject/ShadowsocksR.md#method)加密方式，[17种](./docs/ProxyObject/ShadowsocksR.md#protocol)传输协议，[7种](./docs/ProxyObject/ShadowsocksR.md#obfs)混淆方式
+
++ `VMess`：完整的V2ray内核适配，支持[5种](./docs/ProxyObject/VMess.md#method)加密方式，支持TLS，支持以下传输方式
+
+  + `TCP`：支持obfs混淆
+  + `mKCP`：支持密码混淆，[6种](./docs/ProxyObject/VMess.md#obfs-1)数据包伪装方式
+  + `WebSocket`：支持0-RTT连接
+  + `HTTP/2`：支持自定义域名和路径
+  + `QUIC`：支持[3种](./docs/ProxyObject/VMess.md#method-1)加密方式，[6种](./docs/ProxyObject/VMess.md#obfs-2)数据包伪装
+  + `gRPC`：支持 `gun` 与 `multi` 两种模式
+
++ `VLESS`：完整的Xray内核适配，支持TLS与XTLS，支持的传输方式同上
+
++ `Trojan`：完整的Xray内核适配，支持TLS与XTLS，支持的传输方式同上
+
++ `Trojan-Go`：支持WebSocket连接，Shadowsocks加密连接，TLS加密，[12种](./docs/ProxyObject/TrojanGo.md#type)SIP003插件
+
++ `Brook`：支持UoT开启，WebSocket传输，TLS加密，原始数据传输
+
++ `Hysteria`：支持 `udp`, `wechat-video`, `faketcp` 连接，支持混淆与密码验证
+
++ `Relay`：待支持
+
++ `Snell`：待支持
+
++ `RelayBaton`：待支持
+
++ `PingTunnel`：待支持
+
++ `NaiveProxy`：待支持
+
++ `WireGuard`：待支持
+
++ `SSH`：待支持
diff --git a/docs/ProxyObject/ShadowsocksR.md b/docs/ProxyObject/ShadowsocksR.md
index a6fab5c..1457b1a 100644
--- a/docs/ProxyObject/ShadowsocksR.md
+++ b/docs/ProxyObject/ShadowsocksR.md
@@ -68,9 +68,9 @@
 ### protocol
 
 + 类型：*str*
-+ 说明：ShadowsocksR连接协议
++ 说明：ShadowsocksR传输协议
 + 缺省：`origin`
-+ 限制：（以下17种连接协议）
++ 限制：（以下17种传输协议）
 
 `origin`, `auth_simple`