Merge pull request #18 from branch readme-creation

README.md

@@ -0,0 +1,11 @@
+# UniFlitzer
+
+**UniFlitzer** is an innovative API designed to facilitate ride-sharing among university students. 
+- User accounts: Users can provide detailed information about themselves including their age, cars, driving style and animals. Furthermore, Users can rate, favourite and block each other. Verifying through university login ensures a safe, student-only community.
+- Create drive offers: The API allows drivers to create detailed drive offers with customizable settings. 
+- Request rides: Other users can search and view drive offers and request a ride, whereby the driver decides which users he accepts as passengers. 
+- Drive requests: The creation of drive requests to inspire drivers to create drive offers is also supported. 
+- Drives: The participants of a drive can also see the route including all stops and the driver's current position so they can coordinate with each other.
+- Carpools: Moreover, UniFlitzer promotes the formation of long-term carpools, simplifying future planning and communication.
+<br>
+The project is created during our Master‘s programme at Hof University of Applied Sciences.