Skip to content

Commit ef4915e

Browse files
committed
Add usage to readme
1 parent 1a52d18 commit ef4915e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

Diff for: README.md

+28
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
# rss
22
A [maubot](https://github.com/maubot/maubot) that posts RSS feed updates to Matrix.
3+
4+
## Usage
5+
Basic commands:
6+
7+
* `!rss subscribe <url>` - Subscribe the current room to a feed.
8+
* `!rss unsubscribe <feed ID>` - Unsubscribe the current room from a feed.
9+
* `!rss subscriptions` - List subscriptions (and feed IDs) in the current room.
10+
* `!rss notice <feed ID> [true/false]` - Set whether the bot should send new
11+
posts as `m.notice` (if false, they're sent as `m.text`).
12+
* `!rss template <feed ID> [new template]` - Change the post template for a
13+
feed in the current room. If the new template is omitted, the bot replies
14+
with the current template.
15+
16+
### Templates
17+
The default template is `New post in $feed_title: [$title]($link)`.
18+
19+
Templates are interpreted as markdown with some simple variable substitution.
20+
The following variables are available:
21+
22+
* `$feed_url` - The URL that was used to subscribe to the feed.
23+
* `$feed_link` - The home page of the feed.
24+
* `$feed_title` - The title of the feed.
25+
* `$feed_subtitle` - The subtitle of the feed.
26+
* `$id` - The unique ID of the entry.
27+
* `$date` - The date of the entry.
28+
* `$title` - The title of the entry.
29+
* `$summary` - The summary/description of the entry.
30+
* `$link` - The link of the entry.

0 commit comments

Comments
 (0)