Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fengkx committed Dec 24, 2018
1 parent 86ebf23 commit 857a8e5
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,16 @@ for example `docker run --name rssbot -d -e RSSBOT_TOKEN=123456:abcdef123456-U
# Setting
**All setting can be set by either environment variable or in `config/index.js`**

| 设置项 | 环境变量 | 默认/必填 | 描述 |

| setting | env | default/require | description |
| ------------------ | ---------------- | ---------------- | ---------------------------------------- |
| token | RSSBOT_TOKEN | **require** | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
| db_path | RSSBOT_DB_PATH | data/database.db | 数据库文件路径 |
| lang | RSSBOT_LANG | zh-cn | 语言 |
| item_num | RSSBOT_ITEM_NUM | 5 | 发送最新几条信息 |
| fetch_gap | RSSBOT_FETCH_GAP | 5m | 抓取间隔 |
| notify_error_count | NOTIFY_ERR_COUNT | 5 | 发出通知的错误次数 |
| view_all | RSSBOT_VIEW_ALL | false | 是否开启 |

| db_path | RSSBOT_DB_PATH | data/database.db | path to store database file |
| lang | RSSBOT_LANG | zh-cn | language |
| item_num | RSSBOT_ITEM_NUM | 5 | send the laset number of item |
| fetch_gap | RSSBOT_FETCH_GAP | 5m | fetch gap |
| notify_error_count | NOTIFY_ERR_COUNT | 5 | error count when it will notfiy |
| view_all | RSSBOT_VIEW_ALL | false | enable or not |


language can be setting in `zh-cn` or `en`
Expand Down Expand Up @@ -135,15 +135,15 @@ viewall 只能在私聊中使用
**所有配置项都可以用环境变量或者直接在 `config/index.js`中修改**


| setting | env | default/require | description |
| 设置项 | 环境变量 | 默认/必填 | 描述 |
| ------------------ | ---------------- | ---------------- | ---------------------------------------- |
| token | RSSBOT_TOKEN | **require** | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
| db_path | RSSBOT_DB_PATH | data/database.db | path to store database file |
| lang | RSSBOT_LANG | zh-cn | language |
| item_num | RSSBOT_ITEM_NUM | 5 | send the laset number of item |
| fetch_gap | RSSBOT_FETCH_GAP | 5m | fetch gap |
| notify_error_count | NOTIFY_ERR_COUNT | 5 | error count when it will notfiy |
| view_all | RSSBOT_VIEW_ALL | false | enable or not |
| db_path | RSSBOT_DB_PATH | data/database.db | 数据库文件路径 |
| lang | RSSBOT_LANG | zh-cn | 语言 |
| item_num | RSSBOT_ITEM_NUM | 5 | 发送最新几条信息 |
| fetch_gap | RSSBOT_FETCH_GAP | 5m | 抓取间隔 |
| notify_error_count | NOTIFY_ERR_COUNT | 5 | 发出通知的错误次数 |
| view_all | RSSBOT_VIEW_ALL | false | 是否开启 |

语言可以设置为 `zh-cn` or `en`
时间间隔可设置为每多少分钟或多少小时。m 表示分钟, h表示小时
Expand Down

0 comments on commit 857a8e5

Please sign in to comment.