doc: Update README

imulab · Oct 31, 2023 · 0196d8a · 0196d8a
1 parent 6b27721
commit 0196d8a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -32,15 +32,15 @@ docker pull ghcr.io/imulab/wetriage:latest
 
 The following flags are supported:
 
-| Flag            | Description                                  | Default     | Env           |
-|-----------------|----------------------------------------------|-------------|---------------|
-| `--port`        | Port to listen on                            | `8080`      | `WT_PORT`     |
-| `--debug`       | Enable debug mode                            | `false`     | `WT_DEBUG`    |
-| `--path`        | Customize the callback endpoint path         | `/callback` | `WT_PATH`     |
-| `--token`       | Callback token registered with WeCom         | -           | `WT_TOKEN`    |
-| `--aes-key`     | Base64 encoded AES key registered with WeCom | -           | `WT_AES_KEY`  |
-| `--topic`, `-t` | Callback topic to process. See details below | -           | -             |
-| `--mqtt-url`    | MQTT broker URL. See details below           | -           | `WT_MQTT_URL` |
+| Flag            | Description                                  | Default     | Env                     |
+|-----------------|----------------------------------------------|-------------|-------------------------|
+| `--port`        | Port to listen on                            | `8080`      | `WT_PORT`               |
+| `--debug`       | Enable debug mode                            | `false`     | `WT_DEBUG`              |
+| `--path`        | Customize the callback endpoint path         | `/callback` | `WT_PATH`               |
+| `--token`       | Callback token registered with WeCom         | -           | `WT_TOKEN`              |
+| `--aes-key`     | Base64 encoded AES key registered with WeCom | -           | `WT_AES_KEY`            |
+| `--topic`, `-t` | Callback topic to process. See details below | -           | `WT_TOPICS`, `WT_TOPIC` |
+| `--mqtt-url`    | MQTT broker URL. See details below           | -           | `WT_MQTT_URL`           |
 
 Below shows an example of using the image.
 
@@ -50,7 +50,8 @@ docker run -d \
     -e WT_TOKEN=token \
     -e WT_AES_KEY=base64_encoded_aes_key \
     -e WT_MQTT_URL=tcp://localhost:1883 \
-    ghcr.io/imulab/wetriage:latest WeTriage server -t suite_ticket_info
+    -e WT_TOPICS=suite_ticket_info,create_auth_info \
+    ghcr.io/imulab/wetriage:latest
 ```
 
 ## Topics

diff --git a/README.zh.md b/README.zh.md
@@ -31,15 +31,15 @@ docker pull ghcr.io/imulab/wetriage:latest
 
 支持以下标志：
 
-| 标志             | 描述                       | 默认          | 环境            |
-|----------------|--------------------------|-------------|---------------|
-| `--port`       | 要监听的端口                   | `8080`      | `WT_PORT`     |
-| `--debug`      | 启用调试模式                   | `false`     | `WT_DEBUG`    |
-| `--path`       | 自定义回调端点路径                | `/callback` | `WT_PATH`     |
-| `--token`      | 在微信注册的回调令牌               | -           | `WT_TOKEN`    |
-| `--aes-key`    | 在微信注册的 Base64 编码的 AES 密钥 | -           | `WT_AES_KEY`  |
-| `--topic`，`-t` | 要处理的回调主题。详情请见下文          | -           | -             |
-| `--mqtt-url`   | MQTT 经纪商网址。详情见下文         | -           | `WT_MQTT_URL` |
+| 标志              | 描述                       | 默认          | 环境                      |
+|-----------------|--------------------------|-------------|-------------------------|
+| `--port`        | 要监听的端口                   | `8080`      | `WT_PORT`               |
+| `--debug`       | 启用调试模式                   | `false`     | `WT_DEBUG`              |
+| `--path`        | 自定义回调端点路径                | `/callback` | `WT_PATH`               |
+| `--token`       | 在微信注册的回调令牌               | -           | `WT_TOKEN`              |
+| `--aes-key`     | 在微信注册的 Base64 编码的 AES 密钥 | -           | `WT_AES_KEY`            |
+| `--topic`, `-t` | 需要订阅的回调信息类型              | -           | `WT_TOPICS`, `WT_TOPIC` |
+| `--mqtt-url`    | MQTT 经纪商网址。详情见下文         | -           | `WT_MQTT_URL`           |
 
 下面显示了使用该镜像的示例。
 
@@ -49,7 +49,8 @@ docker run -d \
     -e WT_TOKEN=token \
     -e WT_AES_KEY=base64_encoded_aes_key \
     -e WT_MQTT_URL=tcp://localhost:1883 \
-    ghcr.io/imulab/wetriage:latest WeTriage server -t suite_ticket_info
+    -e WT_TOPICS=suite_ticket_info,create_auth_info \
+    ghcr.io/imulab/wetriage:latest
 ```
 
 ## 消息话题