From 92f736148808fdf180b289e95b593d28a07839c9 Mon Sep 17 00:00:00 2001
From: Deniz <48675506+denizk0461@users.noreply.github.com>
Date: Fri, 12 May 2023 22:43:37 +0200
Subject: [PATCH] Create README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3125073
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+## WeserPlaner – University of Bremen Companion App
+WeserPlaner is a work-in-progress Android app for students at the University of Bremen that allows the user to download their schedule from their Stud.IP account, as well as viewing the offers available in all of the canteens operated by the Studierendenwerk Bremen. Handy features are available, such as adding new events and editing existing events, filtering canteen offers only for such that conform to the user's dietary and ethical preferences (e.g. only displaying vegetarian foods), and filtering out any offers including substances the user is allergic against.
+
+![Screenshots of the WeserPlaner app](https://denizk0461.github.io/weserplaner_showcase.png)
+
+## Progress
+- Downloading and creating events, as well as displaying them is fully functional.
+- Downloading canteen offers, filtering them, and viewing details is fully functional.
+- Viewing additional information on the canteen (opening hours, news) works.
+
+## What's broken
+Currently, nothing is outright broken, but a few things may be bodged together.
+
+## TODO
+- Adding exams, homework, etc.: users will be able to add any tasks they need to do as reminders. Those can be associated with events that either have been downloaded from the user's Stud.IP schedule, or ones the user has created manually. An overview will be provided that allows the user to have, well, an overview of everything they need to do.
+- Optimisations to data handling will be made. The app currently only supports storing a single timetable, which will be changed in future releases. A planned implementation will see the user being able to download schedules as well as create ones from scratch, with the schedules able to be selected via a dropdown menu. 
+- Some UI restructuring to declutter certain screens and improve the UX.
+
+## Why Android-only?
+Because:
+a) I know Android development and it's a lot easier for me to work on an app using a framework I already know than to learn a new one while still trying to keep up with my responsibilities at university, and
+b) because Apple is a greedy company that charges thousands for laptops, phones, as well as $99 a year for a developer account, which are all requirements (sans the phone, if I was to use their simulator, which isn't ideal) and I, as a student, simply do not have the money for that.
+I may reconsider once Apple finally opens up iOS for third-party apps.
+
+![WeserPlaner app icon](https://denizk0461.github.io/weserplaner_app_icon.png)