forked from Lea/UntisBot
Add readme
This commit is contained in:
parent
7a4cb974cb
commit
b8fd904b2e
15
readme.md
Normal file
15
readme.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue