diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..5e670f0 --- /dev/null +++ b/readme.md @@ -0,0 +1,15 @@ +# Untis Bot +Simple bot that notifies you of timetable changes on Discord. + +# Setup +- Clone the repository and CD into it +- `sudo npm install -g typescript` if you haven't already +- Type `tsc` to compile +- Create a `.env` file in the project's root with the following content: + SCHOOLNAME=Your school's name + USERNAME=Your username + PASSWORD=Your password + BASEURL=Your school's Untis URL, for example mese.webuntis.com + BOT_TOKEN=Discord bot token + CHANNEL=The channel ID that the bot sends messages to. Only supports DM channels right now. +- `node dist/index.js` to run the bot. You can use tools like `pm2` to automate starting and stopping. \ No newline at end of file