diff --git a/Home.md b/Home.md index 1883b33..636c06f 100644 --- a/Home.md +++ b/Home.md @@ -1,7 +1,9 @@ ## Welcome to the "TheCitadelofRicks" wiki! -"TheCitadelofRicks" is a API for timetable and mensa data of HS Offenburg. -It's build with spring and kotlin +"TheCitadelofRicks" (tcor for short) is a API for timetable and mensa data of HS Offenburg. +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. ### Build To run the project do `./gradlew bootRun`, or any other standard Gradle task.