From 31dee0a3254145363acc3ceaa755061223656dcb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Rudowicz?= <michal.rudowicz@fl9.eu>
Date: Tue, 24 Jul 2018 15:31:58 +0200
Subject: [PATCH] Added README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b335872
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# AutoBanBot
+
+Automatically kicks and bans users, which first name or last name matches one of predefined regexes,
+from a telegram group.
+
+## Running
+
+Before running the bot, configure the Telegram Bot API and regexes in `config.json`.
+An `config.json.example` file is provided with example values.
+
+```bash
+$ virtualenv -p python3 virtual
+$ source virtual/bin/activate
+$ pip install -r requirements.txt
+$ ./autobanbot.py
+```