feat: Updated README.md

README.md

@@ -23,11 +23,10 @@
 
 ## About
 
-
 This is the long desc
 
-* [x] *list closed tracking-issues or `docs` files here*
-* [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-routes/issues/new) ?
+-   [x] _list closed tracking-issues or `docs` files here_
+-   [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-routes/issues/new) ?
 
 ## Background & Motivation
 
@@ -36,9 +35,9 @@ This is the long desc
 ## Install
 
 1. Install via command line
-	```sh
-	composer require figuren-theater/ft-routes
-	```
+    ```sh
+    composer require figuren-theater/ft-routes
+    ```
 
 ## Usage
 
@@ -53,27 +52,27 @@ Figuren_Theater::API\get_...()
 This package contains the following plugins.
 Thoose are completely managed by code and lack of their typical UI.
 
-* [Mercator](https://github.com/humanmade/Mercator/)
-   WordPress multisite domain mapping for the modern era.
-* ~~[Mercator GUI](https://github.com/humanmade/Mercator-GUI)~~ [Mercator-GUI](https://github.com/carstingaxion/Mercator-GUI)
-   A GUI component for Mercator domain mapping
+-   [Mercator](https://github.com/humanmade/Mercator/)
+    WordPress multisite domain mapping for the modern era.
+-   ~~[Mercator GUI](https://github.com/humanmade/Mercator-GUI)~~ [Mercator-GUI](https://github.com/carstingaxion/Mercator-GUI)
+    A GUI component for Mercator domain mapping
 
 ## What does this package do in addition?
 
 Accompaniying the core functionality of the mentioned plugins, theese **best practices** are included with this package.
 
-- [X] Set base rewrites to german slugs for search, authors and pagination.
-- [X] Include `/wp` as base directory in `network_url()` calls.
-- [X] Use a virtual `/__media` folder per Domain, which rewrites internally to `content/uploads/sites/SITES_ID`.
-- [X] Use aliased domains in `<meta rel="canonical" />` tags, generated by WordPress (by default) or even when outputted by *Yoasts WordPress SEO* Plugin
-- [X] Disable most of the public JSON REST API.
+-   [x] Set base rewrites to german slugs for search, authors and pagination.
+-   [x] Include `/wp` as base directory in `network_url()` calls.
+-   [x] Use a virtual `/__media` folder per Domain, which rewrites internally to `content/uploads/sites/SITES_ID`.
+-   [x] Use aliased domains in `<meta rel="canonical" />` tags, generated by WordPress (by default) or even when outputted by _Yoasts WordPress SEO_ Plugin
+-   [x] Disable most of the public JSON REST API.
 
 ## Built with & uses
 
-  - [dependabot](/.github/dependabot.yml)
-  - [code-quality](https://github.com/figuren-theater/code-quality/)
-     A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
-  - ....
+-   [dependabot](/.github/dependabot.yml)
+-   [code-quality](https://github.com/figuren-theater/code-quality/)
+    A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
+-   ....
 
 ## Contributing
 
@@ -88,6 +87,21 @@ Don't forget to give the project a star! Thanks again!
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
+## Running the Unit Tests
+
+Before running the unit tests, make sure you have PHPUnit installed. If not, you can install it using Composer:
+
+```sh
+composer require --dev phpunit/phpunit ^9
+```
+
+To run the unit tests, navigate to the project's root directory and run the following command:
+
+```sh
+./vendor/bin/phpunit
+```
+
+This will run all the tests in the `tests` directory.
 
 ## Versioning
 
@@ -96,7 +110,7 @@ available, see the [tags on this repository](https://github.com/figuren-theater/
 
 ## Authors
 
-  - **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)
+-   **Carsten Bach** - _Provided idea & code_ - [figuren.theater/crew](https://figuren.theater/crew/)
 
 See also the list of [contributors](https://github.com/figuren-theater/ft-routes/contributors)
 who participated in this project.
@@ -108,8 +122,6 @@ details
 
 ## Acknowledgments
 
-  - [altis](https://github.com/search?q=org%3Ahumanmade+altis) by humanmade, as our digital role model and inspiration
-  - [@roborourke](https://github.com/roborourke) for his clear & understandable [coding guidelines](https://docs.altis-dxp.com/guides/code-review/standards/)
-  - [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow
-
-
+-   [altis](https://github.com/search?q=org%3Ahumanmade+altis) by humanmade, as our digital role model and inspiration
+-   [@roborourke](https://github.com/roborourke) for his clear & understandable [coding guidelines](https://docs.altis-dxp.com/guides/code-review/standards/)
+-   [python-project-template](https://github.com/rochacbruno/python-project-template) for their nice template->repo renaming workflow