aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Schmidt <w4rum@users.noreply.github.com>2018-12-03 17:28:51 +0100
committerGitHub <noreply@github.com>2018-12-03 17:28:51 +0100
commitee572795baef654ee7c23137804408c7ca40207a (patch)
tree98ef9202db0a532d03a93a3a06a3f4776bc4999a
parentCreate LICENSE (diff)
downloadhchat-tg-bridge-ee572795baef654ee7c23137804408c7ca40207a.tar.gz
hchat-tg-bridge-ee572795baef654ee7c23137804408c7ca40207a.zip
Create README.md
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..564e3e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Installation
+
+1. Clone the repository
+2. Create a bot on Telegram by messaging @BotFather and following the instructions.
+3. Copy `config.py.sample` to `config.py`
+4. Change the hack.chat username, password, channel, and the Telegram API token
+5. Change the Telegram chat ID by following the instructions in `config.py`