start work on readme file

README.md

@@ -1,3 +1,27 @@
-# Semesterapparate
+# SemesterapparatsManager
 
-this repo will be used to create a GUI application to manage the semesterapparate of the PH Freiburg.
+SemesterapparatsManager is a graphical tool for managing semester apparatuses in the University of Education Freiburg. It allows the users to manage the semester apparatuses in a user-friendly way. It's functions include management of physical and digital semester apparatuses, as well as creating the citations for the digital files of the digital semester apparatuses. For that it uses Zotero, an open source reference management software. The semester apparatuses are stored in a SQLite database, which is created and managed by the SemesterapparatsManager. The SemesterapparatsManager is written in Python and uses the PyQt6 library for the graphical user interface
+
+
+## Features
+- Manage physical semester apparatuses
+  - Add semester apparatuses
+  - Edit semester apparatuses
+  - Delete semester apparatuses
+  - Extend semester apparatuses
+  - Notify professors about semester apparatuses creation or deletion
+  - Add messages to all semester apparatuses, or an individual semester apparatus
+- Manage digital semester apparatuses
+  - Use text parsing to extract information from the submitted form and create the scans
+    - if a book is used multiple parts of a book are used, it can be split into the parts
+  - Create the matching citations for the files
+- Statistics and Search 
+  - Search semester apparatuses by various criteria
+  - Show statistics about the semester apparatuses creation and deletion
+- Edit user data
+
+
+## Images
+
+![Main Window](docs/images/mainUI.png)
+![Statistics](docs/images/statistics.png)