preparing for a release.HEADmaster

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..a95e802
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+# About
+
+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
+
+osc-mod.lua is originally written by mpv developers.
+It was taken from mpv 0.39.0.
+Look at mpv commit history to know original authors of this file.
+There are small changes by dyknon to:
+
+* Export information about user interactins with osc to other scripts.
+* Unload built-in osc.
+
+dyknon is only a copyright holder of some parts of osc-mod.lua.
+Other files are written by dyknon in 2025.
+
+# License
+
+This program package, mpv-ytdl-storyboard is licensed under
+the GNU Lesser General Public License version 2.1 or later.