Skip to content

Commit

Permalink
update docs && i18n
Browse files Browse the repository at this point in the history
  • Loading branch information
fengkx committed Jun 14, 2019
1 parent 5cd4025 commit 748e6b4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
16 changes: 10 additions & 6 deletions README.md
Expand Up @@ -10,11 +10,9 @@ RSS is parsered using [rss-parser](https://www.npmjs.com/package/rss-parser)

# Usage

The same as [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)

```
/rss - show subscriptions,add raw to show links
/sub - subscribe a RSS: /sub http://example.com/feed.xml
/sub - subscribe a RSS: /sub http://example.com/feed.xml automatically detecting RSS feed is supported
/unsub - unsubscribe a RSS: /unsub http://example.com/feed.xml
/unsubthis - reply a message from a RSS feed to unsubscribe it
/allunsub - unsubscribe all feeds
Expand All @@ -23,6 +21,10 @@ The same as [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)
/import - reply this message a opml file to import(in group)
```

Automatically detecting RSS feed ,you can use `/sub https://www.fengkx.top` rather than `/sub https://www.fengkx.top/atom.xml

You can send multi feeds directly to subscribe in private chat(split by line)

You can add channel id to subscribe a feed for a channel in private chat after adding the bot as administrator
for example `/sub <channel id > <feed url>` (channel id is start with @)

Expand Down Expand Up @@ -116,11 +118,9 @@ RSS 解析用的是 [rss-parser](https://www.npmjs.com/package/rss-parser),它

# Usage

基本与 [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)一致

```
/rss - 显示订阅列表,加 `raw`显示链接
/sub - 订阅 RSS: /sub http://example.com/feed.xml
/sub - 订阅 RSS: /sub http://example.com/feed.xml 支持自动检测 RSS feed
/unsub - 退订 RSS: /unsub http://example.com/feed.xml
/unsubthis - 回复一个 RSS 发来的消息退订该 RSS
/allunsub - 退订所有源
Expand All @@ -129,6 +129,10 @@ RSS 解析用的是 [rss-parser](https://www.npmjs.com/package/rss-parser),它
/import - 回复此消息 opml 文件导入订阅(群组)
```

自动检测 RSS feed,可以直接 `/sub https://www.fengkx.top` 而不用 `/sub https://www.fengkx.top/atom.xml`

私聊可以直接发送 feed 地址订阅,支持同时发送多个地址按行分割

把 bot 设为频道管理员并正确配置权限后,可通过私聊在`/sub`后加上频道 id 来在频道中订阅 feed
例如 `/sub <频道 id > <feed url>` (频道 id 是@打头的)

Expand Down
2 changes: 1 addition & 1 deletion i18n/en.yaml
Expand Up @@ -5,7 +5,7 @@ FETCH_ERROR: Fetch error
ALREADY_SUB: You have already subscribe this feed
DB_ERROR: SQL error
DID_NOT_SUB: You haven't subscribed this feed
SUB_USAGE: 'USAGE: /sub <RSS URL>'
SUB_USAGE: 'USAGE: /sub <RSS URL> automatically detecting RSS feed is supported'
UNSUB_USAGE: 'USAGE: /unsub <RSS URL>'
ADMIN_ONLY: Only enable for admins
UNSUBTHIS_USAGE: 'USAGE:/unsubthis Reply the message from the feed you want to unsubscribe directly'
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-cn.yaml
Expand Up @@ -5,7 +5,7 @@ FETCH_ERROR: 抓取错误
ALREADY_SUB: 已经订阅过了
DB_ERROR: SQLite操作出错
DID_NOT_SUB: 你没有订阅这个feed
SUB_USAGE: 使用方法: /sub <RSS URL>
SUB_USAGE: 使用方法: /sub <RSS URL> 支持自动检测 RSS feed
UNSUB_USAGE: 使用方法: /unsub <RSS URL>
ADMIN_ONLY: 只有管理员才能操作
UNSUBTHIS_USAGE: 使用方法:/unsubthis 回复想要退订的 RSS 消息
Expand Down

0 comments on commit 748e6b4

Please sign in to comment.