From 3c180ae61ebc8c5fa1c4a28d5d65642d1c733502 Mon Sep 17 00:00:00 2001
From: nite07 <admin@nite07.com>
Date: Tue, 19 Mar 2024 17:20:58 +0800
Subject: [PATCH] update: README

---
 README.md | 42 +++++++++---------------------------------
 1 file changed, 9 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index f47a1b1..d6b3c4e 100644
--- a/README.md
+++ b/README.md
@@ -1,43 +1,18 @@
 # sub2sing-box
 
-## Cli Command
+## cli
 
-### convert
+- convert: 转换
+- server: 启动 Web UI
+- version: 版本信息
 
-```
-Convert common proxy to sing-box proxy
+`sub2sing-box <command> -h` 查看帮助
 
-Usage:
-   convert [flags]
-
-Flags:
-  -d, --delete string           delete proxy with regex
-  -h, --help                    help for convert
-  -o, --output string           output file path
-  -p, --proxy strings           common proxies
-  -r, --rename stringToString   rename proxy with regex (default [])
-  -s, --subscription strings    subscription urls
-  -t, --template string         template file path
-```
-
-### server
-
-```
-Run the server
-
-Usage:
-   server [flags]
-
-Flags:
-  -h, --help          help for server
-  -p, --port uint16   server port (default 8080)
-```
-
-#### api
+## api
 
 ##### GET /convert
 
-- `data`: Base64 编码的 JSON 字符串，包含以下字段：
+- `data`: Base64 编码(url safe)的 JSON 字符串，包含以下字段：
   - `subscription`: []string
   - `proxy`: []string
   - `delete`: string 可选
@@ -45,6 +20,7 @@ Flags:
   - `template`: map[string]string 可选
 
 示例
+
 ```
 {
   "subscription": ["url1", "url2"],
@@ -72,4 +48,4 @@ Template 中使用 `<all-proxy-tags>` 指明节点插入位置，例如
 
 ## Docker
 
-`docker run -p 8080:8080 nite07/sub2sing-box`
\ No newline at end of file
+`docker run -p 8080:8080 nite07/sub2sing-box`