From dea2bd551f6dbebf43e934175dceda38938e7a5e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <daniel.q.mueller@stud.h-da.de>
Date: Thu, 24 Jun 2021 15:31:38 +0000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c8cad7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# BBB Volume Slider - Userscript
+## What does it do?
+
+This userscript injects a simple volume slider into Big Blue Button sessions. The slider is currently placed 
+at the top right corner next to the `...` menu using absolute positioning (not optimal but it works).
+
+The slider adjusts the volume of all audio output created by Big Blue Button which helps with the problem of 
+audio beeing way too loud.
+
+## How can I use it?
+
+This project is implemented as a userscript which means a userscript manager is needed to use it. The code was 
+tested with [Tampermonkey](https://www.tampermonkey.net) on firefox but should work on every browser with any 
+userscript plugin.
+
+
+### Install and use with tampermonkey
+
+1. Install tampermonkey (https://www.tampermonkey.net)
+2. Install the [volume slider userscript](https://code.fbi.h-da.de/istddmue2/bbb-volume-slider-userscript/-/raw/master/bbb-volume-slider.user.js) . Clicking this link should automatically open the install dialog when tampermonkey 
+is installed
+3. Profit
-- 
GitLab