Update README

shimmeris · shimmeris · commit 8f856054d655 · 2023-01-12T20:49:05.000+08:00
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 [README](README.md) | [中文文档](README_zh.md)
 
-SCFProxy is a tool that implements multiple proxies based on cloud functions and API gateway functions provided by cloud
-providers.
+SCFProxy is a tool to implement HTTP proxy, SOCKS proxy, and reverse proxy based on cloud function and API gateway
+provided by several cloud service providers.
 
 # Installation
 
@@ -81,15 +81,15 @@ and then filling the corresponding role ARN into the ` sdk.toml` file.
 
 ## Query
 
-The `scfproxy list` accepts five arguments `provider`, `region`, `http`, `socks`, `reverse`.
+The `scfproxy list` accepts the following five parameters.
 
-The `provider` parameter lists the currently supported cloud providers and can be filtered by
-the `-m [http|socks|reverse]` parameter to find the providers that support a certain proxy.
-
-The `region` argument is used to list the regions where the cloud provider can be deployed, and the `-p providers`
-parameter is used to specify the cloud provider
-
-The `http`, `socks`, `reverse` arguments are used to list the currently deployed proxies
+* `provider` lists currently supported cloud providers and can be filtered by the `-m [http|socks|reverse]` parameter to
+  find the providers that support a certain proxy.
+* `region` list regions where cloud provider can be deployed, and the `-p providers` parameter is used to specify the
+  cloud provider
+* `http` Lists deployed HTTP proxies
+* `socks` Lists deployed SOCKS proxies
+* `reverse` List deployed reverse proxies
 
 ## HTTP proxy
 
@@ -144,6 +144,10 @@ equivalent to `0.0.0.0:port`
 Running HTTP proxy will load the records in `~/.config/scfproxy/http.json`, and if there are multiple deployed cloud
 functions (regardless of provider), each HTTP request will randomly pick one of them to proxy.
 
+#### Use effect
+
+![http](img/http.jpg)
+
 ### Clear
 
 ```console
@@ -186,7 +190,7 @@ randomly pick one of the connections from the cloud function to proxy.
 > The current timeout for socks proxy functions is 15m, so if you use socks proxy for a long connection such as mysql
 > connection, you need to schedule it by yourself to avoid accidental connection disconnection when the time is up.
 
-### Usage effect
+#### Use effect
 
 **Long connections**
 
diff --git a/README_zh.md b/README_zh.md
@@ -1,6 +1,6 @@
 # SCFProxy
 
-SCFProxy 是一个基于云服务商提供的云函数及 API 网关功能实现多种代理的工具。
+SCFProxy 是一个基于多个云服务商提供的云函数及 API 网关实现 HTTP 代理、SOCKS 代理、反向代理的工具。
 
 # 安装
 
@@ -75,13 +75,13 @@ AWS 需要下述凭证:
 
 ## 查询
 
-`scfproxy list` 接受 `provider`, `region`, `http`, `socks`, `reverse` 五种参数。
+`scfproxy list` 接受以下五种参数：
 
-`provider` 参数列出目前支持的云厂商，可通过 `-m [http|socks|reverse]` 参数过滤出支持某种代理的厂商。
-
-`region` 参数用于列出云厂商可部署的区域，需使用 `-p providers` 指定需要查看的云厂商
-
-`http`, `socks`, `reverse` 参数用于列出目前已经部署的代理
+* `provider` 用于列出目前支持的云厂商，可通过 `-m [http|socks|reverse]` 参数过滤出支持某种代理的厂商。
+* `region` 用于列出云厂商可部署的区域，需使用 `-p providers` 指定需要查看的云厂商
+* `http` 列出已部署的 HTTP 代理
+* `socks` 列出已部署的 SOCKS 代理
+* `reverse` 列出已部署的 反向代理
 
 ## HTTP 代理
 
@@ -131,6 +131,10 @@ scfproxy http -l address [-c cert_path] [-k key_path]
 HTTP 代理运行将读取 `~/.config/scfproxy/http.json` 中的记录，如果存在多个已部署的云函数（不区分厂商），每个 HTTP
 请求将随机挑选其中的云函数进行代理。
 
+#### 使用效果
+
+![http](img/http.jpg)
+
 ### 清理
 
 ```console
@@ -171,7 +175,7 @@ socks 命令需要加载 `sdk.toml` 用于触发函数，及部署后生成的 `
 > 目前 socks 代理部署的函数超时时间为 15m，因此如果将 socks 代理用于一个长连接如 mysql 连接，需自行安排好时间，避免时间一到导致连接意外断开。
 >
 
-### 使用效果
+#### 使用效果
 
 **长连接**
 
diff --git a/img/http.jpg b/img/http.jpg
