lucy/UntisBot
1
0
Fork 0
forked from Lea/UntisBot
Code Issues Pull requests Projects Releases Wiki Activity

Update readme

Browse source
This commit is contained in:
Jan 2020-12-03 20:34:29 +01:00
parent b8fd904b2e
commit 01bbb34364
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
readme.md
View file

@ -6,10 +6,10 @@ Simple bot that notifies you of timetable changes on Discord.
- `sudo npm install -g typescript` if you haven't already - `sudo npm install -g typescript` if you haven't already
- Type `tsc` to compile - Type `tsc` to compile
- Create a `.env` file in the project's root with the following content: - Create a `.env` file in the project's root with the following content:
SCHOOLNAME=Your school's name - SCHOOLNAME=Your school's name
USERNAME=Your username - USERNAME=Your username
PASSWORD=Your password - PASSWORD=Your password
BASEURL=Your school's Untis URL, for example mese.webuntis.com - BASEURL=Your school's Untis URL, for example mese.webuntis.com
BOT_TOKEN=Discord bot token - BOT_TOKEN=Discord bot token
CHANNEL=The channel ID that the bot sends messages to. Only supports DM channels right now. - 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. - `node dist/index.js` to run the bot. You can use tools like `pm2` to automate starting and stopping.