docs(README): v0.8.6

iyear · May 17, 2023 · 9c22a31 · 9c22a31
1 parent 2ebbf54
commit 9c22a31
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -226,6 +226,17 @@ tdl --ntp pool.ntp.org
 export TDL_NTP=pool.ntp.org # recommended
 ```
 
+- (optional) Set Telegram client reconnect timeout. Default is 30s:
+
+> **Note**
+> Set higher timeout or 0(INF) if your network is poor.
+
+```shell
+tdl --reconnect-timeout 1m30s
+# or
+export TDL_RECONNECT_TIMEOUT=1m30s
+```
+
 ### Login
 
 > When you first use tdl, you need to login to get a Telegram session
@@ -475,16 +486,17 @@ Avoid typing the same flag values repeatedly every time by setting environment v
 
 What flags mean: [flags](docs/command/tdl.md#options)
 
-|     NAME     |      FLAG       |
-|:------------:|:---------------:|
-|    TDL_NS    |    `-n/--ns`    |
-|  TDL_PROXY   |    `--proxy`    |
-|  TDL_DEBUG   |    `--debug`    |
-|   TDL_SIZE   |   `-s/--size`   |
-| TDL_THREADS  | `-t/--threads`  |
-|  TDL_LIMIT   |  `-l/--limit`   |
-|   TDL_NTP    |     `--ntp`     |
-| TDL_TEMPLATE | dl `--template` |
+|         NAME          |         FLAG          |
+|:---------------------:|:---------------------:|
+|        TDL_NS         |       `-n/--ns`       |
+|       TDL_PROXY       |       `--proxy`       |
+|       TDL_DEBUG       |       `--debug`       |
+|       TDL_SIZE        |      `-s/--size`      |
+|      TDL_THREADS      |    `-t/--threads`     |
+|       TDL_LIMIT       |     `-l/--limit`      |
+|        TDL_NTP        |        `--ntp`        |
+| TDL_RECONNECT_TIMEOUT | `--reconnect-timeout` |
+|     TDL_TEMPLATE      |    dl `--template`    |
 
 ## Data
 

diff --git a/README_zh.md b/README_zh.md
@@ -229,6 +229,18 @@ tdl --ntp pool.ntp.org
 export TDL_NTP=pool.ntp.org # 推荐做法
 ```
 
+- (可选) 设置 Telegram 连接重试超时时间。默认为 30s：
+
+> **Note**
+> 如果网络环境较差请设置更高的超时时间或 0(无限)
+
+```shell
+tdl --reconnect-timeout 1m30s
+# or
+export TDL_RECONNECT_TIMEOUT=1m30s
+```
+
+
 ### 登录
 
 > 当你第一次使用 tdl 时，你需要登录以获取一个 Telegram 会话
@@ -481,16 +493,17 @@ tdl chat export -c CHAT_INPUT --with-content
 
 命令行参数含义: [flags](docs/command/tdl.md#options)
 
-|     环境变量     |      命令行参数      |
-|:------------:|:---------------:|
-|    TDL_NS    |    `-n/--ns`    |
-|  TDL_PROXY   |    `--proxy`    |
-|  TDL_DEBUG   |    `--debug`    |
-|   TDL_SIZE   |   `-s/--size`   |
-| TDL_THREADS  | `-t/--threads`  |
-|  TDL_LIMIT   |  `-l/--limit`   |
-|   TDL_NTP    |     `--ntp`     |
-| TDL_TEMPLATE | dl `--template` |
+|         环境变量          |         命令行参数         |
+|:---------------------:|:---------------------:|
+|        TDL_NS         |       `-n/--ns`       |
+|       TDL_PROXY       |       `--proxy`       |
+|       TDL_DEBUG       |       `--debug`       |
+|       TDL_SIZE        |      `-s/--size`      |
+|      TDL_THREADS      |    `-t/--threads`     |
+|       TDL_LIMIT       |     `-l/--limit`      |
+|        TDL_NTP        |        `--ntp`        |
+| TDL_RECONNECT_TIMEOUT | `--reconnect-timeout` |
+|     TDL_TEMPLATE      |    dl `--template`    |
 
 ## 数据