From c34f05e9d449c80a545a25c8da5f791b37f722fe Mon Sep 17 00:00:00 2001 From: ByteDream Date: Fri, 4 Dec 2020 22:01:21 +0100 Subject: [PATCH] Release preparations --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e807197..651e41a 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ### UntisBot -**UntisBot** is a java programmed discord bot, which uses the [WebUntis](https://webuntis.com/) timetable software / api to automatically sends messages when the timetable from a given account or class changes. +**UntisBot** is a java programmed discord bot, which uses the [WebUntis](https://webuntis.com/) timetable software / api +to receive the timetable for a specific date, automatically send messages when the timetable from a given account or class changes, displays absent teachers, and more! You can invite the bot right [here](https://discord.com/api/oauth2/authorize?client_id=768841979433451520&permissions=268437504&scope=bot) or [host it yourself](#Self-hosting).

@@ -65,7 +66,7 @@ When you run the bot manually you can choose from 2 types of data storage: ### In-memory storage -In memory data storage is pretty simple: Just download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.0/UntisBot-1.0.jar) and run it with `java -jar UntisBot-1.0.jar token=`. +In memory data storage is pretty simple: Just download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1/UntisBot-1.0.jar) and run it with `java -jar UntisBot-1.0.jar token=`. The simple things have unfortunately also often disadvantages: The user data is only stored as long as the bot is running. If you shut it down, all data will be lost. If you want to keep the data even after a shutdown, you should use [database storage](#MariaDB). @@ -82,7 +83,7 @@ To set up the database, you have to execute the following command and replace `< mysql -u -p -e "CREATE DATABASE Untis; USE Untis; $(wget -qO- https://raw.githubusercontent.com/ByteDream/untisbot-discord/master/files/database.sql)" ``` -Now you have set up the database and are ready to go. Download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.0/UntisBot-1.0.jar) and run it with `java -jar UntisBot-1.0.jar mariadb`. +Now you have set up the database and are ready to go. Download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1/UntisBot-1.0.jar) and run it with `java -jar UntisBot-1.0.jar mariadb`. ## Run options @@ -169,7 +170,7 @@ If you want to add a language which isn't supported you can - [Database client](https://github.com/mariadb-corporation/mariadb-connector-j) (mariadb java client) - [Logger](https://github.com/qos-ch/logback) (logback-core and logback-classic) -**_Note_: The [UntisBot jar file](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.0/UntisBot-1.0.jar) and the [Dockerfile](Dockerfile) are containing all dependencies.** +**_Note_: The [UntisBot jar file](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1/UntisBot-1.0.jar) and the [Dockerfile](Dockerfile) are containing all dependencies.** ## License