From afdff3a90c522644d80c9eee99c2b1519f21eb65 Mon Sep 17 00:00:00 2001
From: Hannes Kuchelmeister <13hannes11@users.noreply.github.com>
Date: Mon, 6 Sep 2021 17:59:57 +0200
Subject: [PATCH] Add readme.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dcab6e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# ics-proxy
+
+## Motivation
+
+This application was build because of my frustration with my Universities publishing of schedules. Schedules can be found on [TimeEdit](https://cloud.timeedit.net), 
+however, changes to my schedule (for example dropping a course) meant that all ics links on all of my devices needed to be replaced. 
+Additionally each semester this needed to be done as well. I therefore created this proxy to have an easy way of replaceing ics links without needing to update the link in my callenders.
+
+## Buidling
+
+The easiest way to build this repository is to use docker. You can simply run `docker build -t ics-proxy .`
+
+## Deployment
+
+To deploy you can simply use the `docker-compose.yml` file.