diff --git a/Home.md b/Home.md index d411cbd..5c57087 100644 --- a/Home.md +++ b/Home.md @@ -5,11 +5,29 @@ It's build with spring and kotlin. tcor currently provides 3 request options. /courses which will return a array "courses" with all currently available courses at the HS Offenburg, /timetable?courseName={coursename}&week={week} which will return a given weeks timetable for a given course and /mensamenu which will return the menu of the mensa for the current and next week. +Since software version 1.2.0 tcor supports cachet api reporting. + Just as a side note, if you ever wonder why lessons are calld lessons and not lectures, it's to be in line with the offical hs timetable naming schema. ### Build To run the project do `./gradlew bootRun`, or any other standard Gradle task. +### Install/Configuration +Tcor will create a ".tcor" folder on first startup in the users home directory. In there is a folder containing the cached timetable data and a "config.xml" file. Via the config file it is possible to set a swfr mensa url and name, as well as the cachet base url and the cachet api key. + +Here is an example of the config.xml: +``` xml + + + +tcor configuration +https://status.mosad.xyz +https://www.swfr.de/de/essen-trinken/speiseplaene/mensa-offenburg/ +0 +Offenburg + +``` + ### Libraries * jsoup: https://jsoup.org/ * spring: https://spring.io/projects/spring-boot