From 539f9dcb38f0dc7f1a5368deabbd965b014ca19c Mon Sep 17 00:00:00 2001
From: sqozz <sqozz@geekify.de>
Date: Tue, 25 May 2021 13:31:29 +0200
Subject: [PATCH] Update 'README.md'

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index e69de29..42204c4 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,19 @@
+This script fetches data from the "Abfallnavi" application developed by "regio iT" (https://www.regioit.de/produkte-leistungen/entsorgung/abfallapp-abfallnavi/) and converts it into ical files to import them in any regular calendar software. It is currently tested and used in Nuremberg.
+
+Other cities which could be supported in the future:
+  - Aachen (https://serviceportal.aachen.de/abfallnavi)
+  - Bergischer Abfallwirtschaftsverband (https://www.bavweb.de/Kommunale-Entsorgung/)
+    - Engelskirchen (https://www.bavweb.de/Kommunale-Entsorgung/Engelskirchen/)
+    - …
+  - Ahlen (https://www.ahlen.de/start/aub/abfallbeseitigung/abfall-navi/)
+  - Solingen (https://www.solingen.de/tbs/inhalt/abfallnavi/)
+  - Borgholzhausen (https://www.borgholzhausen.de/sv_borgholzhausen/Leben/Ver-%20und%20Entsorgung/Abfallentsorgung%20u.%20Beratung/Tonnenticker/)
+  - And probably many more, let me know!
+
+Installation
+===
+
+1. Clone the repository
+2. Setup a python virtualenv with `virtualenv venv` and activate it with `. ./venv/bin/activate`
+3. Install requirements with `pip install -r requirements.txt`
+4. Run the generator: `python generate_ical.py`
\ No newline at end of file