From f08c53c69b927c6dd2fec6f7aebe4d0a7bf83956 Mon Sep 17 00:00:00 2001
From: Nathan Mattes <hallo@bullenscheisse.de>
Date: Thu, 18 May 2023 11:10:33 +0200
Subject: [PATCH] Add some more information to README (#1)

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a28799b..e731d0f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
-# ventilator
-## Podcasts for your ears only
+# Ventilator
+
+- Podcasts for your ears only
+- Simple CMS to manage your podcast and its episodes
+- [Issue Tracker][issue-tracker] and [git repository][git-repo]
+
+[git-repo]: https://git.wtf-eg.de/zeitschlag/ventilator
+[issue-tracker]: https://git.wtf-eg.de/zeitschlag/ventilator/issues
+
+## Run it
+
+```shell
+# do the env-dance
+$ pip install -r requirements.txt
+$ python manage.py migrate
+$ python manage.py runserver
+```
+
+## Development
+
+- Standard Django-project
+- Keep it simple. No overengineered JS-frontend-stuff, when it's not necessary. Thank you :)
+- Feel free to grab an issue and just work on it :) PRs are always welcome! Thank you for you help!
+- We use git (obviously)
+- Don't commit without an issue-reference in the commit-message. PRs won't be squashed.
\ No newline at end of file