README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..25f2705
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Someone's Mattermost bot.
+ +  Copyright (c) 2016-2021 by Someone <someone@somenet.org> (aka. Jan Vales <jan@jvales.net>)
+ +  published under MIT-License
+
+Started out as a simple means to lock channels into "read-only" mode by creating outgoing webhooks and deleting every incomming message.
++ This code is long gone/rebased away.
+
+Currently this bot's uses range from fun `/threads` `/order` to something helpful `/join-all` and to moderative features like `/ta-wipe-channel` or `/mod-del` and displays dialogs.
+
+
+## Installation:
++ pip3 install --user --upgrade -r requirements.txt
++ create a config.py file from config.py.example.
++ make systemd start this bot (see somebot.service)
++ periodically run some cronjobs, like these:
+
+    ### bot command stats
+
+    */5 * * * *   (XDG_RUNTIME_DIR=/run/user/1002 systemctl --user kill -s SIGUSR1 somebot.service) &> /dev/null
+
+    59 11 * * *   (cd /srv/mattermost/mattermost-bot; python3 -u command_stats_printer.py | python3 -m mattermost.stdin2channel http://localhost:8065/api user pw channel '``AUTODELETE-DAY`` #command_usage #mmstats\n```\n' '\n```'; rm  /tmp/somebot_command_stats.json) &> /dev/null
+