From af4b443147374e5e8e061bc940dceef92a062f2d Mon Sep 17 00:00:00 2001
From: Siphalor <info@siphalor.de>
Date: Fri, 13 May 2022 10:29:45 +0200
Subject: [PATCH] Add a README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9cde22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# bora.sh
+
+A simple shell script to theorize downloading specific lecture videos from a Moodle/BigBlueButton instance.
+
+## Installation
+
+You'll need to install `wget` and `ffmpeg`. Your favorite package manager should do the trick.
+
+## Usage
+
+Run with:
+
+```sh
+./bora.sh <URL> <output>
+```
+
+The output will default to `out.mp4` but may be any file type that FFmpeg supports.
+
+The downloads will be cached in a local `tmp` directory and are continued in case the connection fails.
+
+If no URL is given, the files are assumed to be called `webcams.webm` and `deskshare.webm`.