add documentation
This commit is contained in:
parent
0d800b1a69
commit
0d77a94124
29
README.md
Normal file
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"
|
||||
|
|
Loading…
Reference in a new issue