aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..54ffd74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# SE Lecture Optimizer
+
+## About
+
+This script suppresses the automatic preloading and buffering of all videos
+on the SE lecture page.
+
+By default, all videos are prebuffered and even played at once. The first causes
+long waiting time before the site is usable and breaks slow bandwidth connections.
+The second causes high disturbance to the user.
+
+## Installation
+
+### Tampermonkey
+
+This script is usable with Tampermonkey plugin ([for Firefox](https://addons.mozilla.org/de/firefox/addon/tampermonkey/),
+[for Chrome](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo)).
+
+1. Install Tampermonkey plugin.
+2. Click the Tampermonkey icon on the top right corner.
+3. Go to `Dashboard -> Utilities tab -> Install from URL`.
+4. Copy and paste this URL there, and click install: `https://collaborating.tuhh.de/cev7691/selectureoptimizer/raw/master/SELectureOptimizer.js`.
+5. Confirm installation by clicking `Install`.
+6. Reload SE Lecture website.