pub / tw2html

commit 67e071ef8ac2c3d3eff2e00168fa3534bf79e85b
parent 373bb1a796b5a0bd1a75f5da9d06ea77ea31a526
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date:   Sat, 20 Apr 2024 13:31:39 +0200

Add explainations for scheme handling

Diffstat:
M
README.md
 | 
27
++++++++++++++++++++++++++-

1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -27,9 +27,17 @@ The site will show you a loading screen, while the status of streams are fetched
 
 tw2html offers buttons with the custom `streamlink://` scheme. It gives you the opportunity to open up streams on your computer via streamlink.
 
+**For Mozilla Firefox:**
+
+Add following key in [`about:config`](about:config):
+
+- Key: `network.protocol-handler.expose.streamlink`
+- Type: Boolean
+- Value: `true`
+
 **For GNU/Linux:**
 
-You need to add a streamlink-handler, such as:
+In addition to the scheme handler in your browser (see above for Firefox), you need to add a streamlink-handler (e.g. in `~/.local/bin/streamlink-handler.sh`), such as:
 
 ```bash
 #!/usr/bin/env bash
@@ -44,3 +52,20 @@ streamlink \
   --title "${TITLE}" \
   "${URL}" best
 ```
+
+and the according `.desktop` file (e.g. in `~/.local/share/applications/streamlink-handler.desktop`):
+
+```
+[Desktop Entry]
+Type=Application
+Name=Streamlink Scheme Handler
+Exec=.local/bin/streamlink-handler.sh %u
+StartupNotify=false
+NoDisplay=true
+MimeType=x-scheme-handler/streamlink;
+```
+
+Afterwards, add the new scheme handler to xdg:
+```bash
+xdg-mime default streamlink-handler.desktop x-scheme-handler/streamlink
+```