diff --git a/README.md b/README.md new file mode 100644 index 0000000..762890c --- /dev/null +++ b/README.md @@ -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`. diff --git a/config.ini.dist b/config.ini.dist index 3ebbe4c..b10def6 100644 --- a/config.ini.dist +++ b/config.ini.dist @@ -6,4 +6,4 @@ file = 'cache.db' [mattermost] hook_url = -message_template = +message_template = "« %1$s » %2$s"