docs: improve README
Feature
Summary
This MR provides an update of the README fixing everything @sendler discovered during his code review (thanks for this!).
Compliance to “Definition of Done”
-
Unit tests passed -
Code reviewed -
Product Owner accepts the User Story
Documentation
-
I updated the README (if applicable)
Tests
Are we able to test this new feature?
-
Yes, you can test by following these steps:
Have a look at https://gitlab.gwdg.de/subugoe/ahiqar/backend/-/blob/feature/readme-update/README.md.