Browse Source

add documentation

master
Simon Vieille 8 months ago
parent
commit
0d77a94124
Signed by: deblan <simon@deblan.fr> GPG Key ID: 03383D15A1D31745
2 changed files with 30 additions and 1 deletions
  1. +29
    -0
      README.md
  2. +1
    -1
      config.ini.dist

+ 29
- 0
README.md View 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`.

+ 1
- 1
config.ini.dist View File

@@ -6,4 +6,4 @@ file = 'cache.db'

[mattermost]
hook_url =
message_template =
message_template = "« %1$s » %2$s"

Loading…
Cancel
Save