From 231c35fbd830d38d85a2350c223f998869b618d6 Mon Sep 17 00:00:00 2001 From: Mark Hoekveen Date: Tue, 30 Jun 2020 11:37:07 +0200 Subject: [PATCH] Adds readme with install instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..81cf4da --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file