From e7b34ac7e9c55707c24b73a9d45d6bf8098cc9f9 Mon Sep 17 00:00:00 2001
From: Richard <richard@fsmpi.rwth-aachen.de>
Date: Tue, 13 Oct 2020 02:13:52 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..66c9cc5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+About This Software
+-------------------
+
+**WARNING:** This extension is neither …
+  - packaged
+  - thouroughly testes
+  - approved or endorsed by RWTH or FSMPI
+  - well supported
+  - the answer to life, universe, and everything
+  - readable
+
+**Use at your own risk!**
+
+Further development is necessary and will take place when I find some more free time …
+
+
+### what is it good for?
+
+A huge portion of videos in RWTH moodle are hosted on RWTH's OpenCast instance.
+The way it is set up prevents (likely intentionally) a user-friendly approach to downloading videos.
+This extension want's to help by liberating lecture recordings and other videos provided in this rather restrictive manner.
+
+How?
+By placing a bow with direct links to the videos above them.
+
+### reasons for downloading vidoes
+  - a bad internet connection (streaming feels like 90% buffering and 10% watching)
+  - learning on the train, at the beach, in the park, … you get it
+  - personal archive to re-watch lecture contents in a few semesters (relevant for exams, personal interest, …)
+  - …
+
+### 2do
+  - going to bed
+  - styling (I love CSS, not joking here!)
+  - adding links in video-only tabs, too
+  - packaging
+  - good name + icon
+  - further investigation into the OpenCast API (looks like one might be able to have some fun with it)
+  - …
-- 
GitLab