summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 28 insertions, 3 deletions
diff --git a/README b/README
index 517c45c..30e2355 100644
--- a/README
+++ b/README
@@ -1,4 +1,29 @@
-osc.lua (moved from player/lua/) and some documentations about copyright.
-Copied from mpv 0.41.0 debian release.
+# About
-Authors are listed in debian/copyright.
+Show "storyboard" of YouTube,
+when you use mpv to play YouTube video, and hover on the seekbar.
+
+# How to use
+
+make, then copy files to your "scripts" folder.
+
+make ytdl-storyboard.so
+cp ytdl-storyboard.so osc-mod.lua ~/.config/mpv/scripts
+
+# Copyright
+
+Copyright dyknon 2025, 2026
+
+osc-mod.lua is originally written by mpv developers.
+It was taken from mpv 0.41.0. Check tag: mpv-0.41.0-osc-mod.
+There are small changes by dyknon to:
+
+* Export information about user interactins with osc to other scripts.
+* Unload built-in osc.
+
+Other files are written by dyknon.
+
+# License
+
+This program package, mpv-ytdl-storyboard is licensed under
+the GNU Lesser General Public License version 2.1 or later.