add documentation

This commit is contained in:
Simon Vieille 2019-07-25 10:03:45 +02:00
父節點 0d800b1a69
當前提交 0d77a94124
簽署人: deblan
GPG Key ID: 03383D15A1D31745
共有 2 個文件被更改,包括 30 次插入1 次删除

29
README.md Normal file
查看文件

@ -0,0 +1,29 @@
Mattermost BOT
==============
Read a RSS feed and post items in a mattermost channel.
Installation
------------
```bash
$ git clone https://gitnet.fr/deblan/mattermost-bot.git
$ cd mattermost-bot
$ cp config.ini.dist config.ini
```
### Example of `config.ini`
```ini
[feed]
url = "https://www.example.com/feed/"
[cache]
file = 'cache.db'
[mattermost]
hook_url = "https://mattermost.example.com/hooks/1234567890abcdefghijklm"
message_template = "« %1$s » %2$s #foo #bar"
```
Then run `php index.php`.

查看文件

@ -6,4 +6,4 @@ file = 'cache.db'
[mattermost]
hook_url =
message_template =
message_template = "« %1$s » %2$s"