Adds readme with install instructions

2020-06-30 11:37:07 +02:00
parent ec96b714e3
commit 231c35fbd8
1 changed files with 12 additions and 0 deletions
@@ -0,0 +1,12 @@
+# Timerbot
+Simple discord bot (written using [discord.py](https://github.com/Rapptz/discord.py)), that keeps track of simple short timers.
+
+Mainly useful for short challenges done with friends, or keeping track of short breaks.
+
+## Deploying
+Download these files, [create a bot token](https://discord.com/developers/applications) and put it in a `settings.ini` file as so:
+```
+[tokens]
+bot = YOUR.TOKEN
+```
+Install discordpy using your favorite method, and run the bot with `python Bot.py`. Some recent-ish version of Python is probably required.