From 586308eb1f5c1401e7a1aafb82a78c9000672376 Mon Sep 17 00:00:00 2001 From: hensm Date: Fri, 8 Jun 2018 20:07:11 +0100 Subject: [PATCH] Add usage details to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 73ba583..af439b7 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ Only tested on Linux. mDNS library issue to be fixed. `mdns` only works on Windo * `node` binary in path * ~~Bonjour SDK (Windows)~~ +### Instructions + ```` git clone https://github.com/hensm/caster.git npm install ./ext --prefix ./ext @@ -37,10 +39,16 @@ Installer scripts aren't written yet, so registering the native messaging manife `path` key within `app/caster_bridge.json` must be set to absolute path of `app/src/launcher.sh` or `app/src/launcher.bat`. Then, the manifest must be either moved to the correct location or the path added to the registry (Windows): [MDN: Native Manifests # Manifest location](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_manifests#Manifest_location) +## Usage + Extension can be loaded from `about:debugging` as a temporary extension. Most sites won't load the cast API unless the browser presents itself as Chrome. The plan is to spoof the user agent string for a whitelist of cast-enabled sites, but that isn't implemented yet. You can workaround this by setting it manually or using a [third-party extension](https://addons.mozilla.org/en-US/firefox/search/?q=user+agent). +HTML5 media elements have a "Cast..." context menu item that triggers a sender application. Only works on remote (non-local) media that isn't DRM-encumbered. + +Cast-enabled websites will load the sender API shim and display a cast button as in Chrome, provided there are no bugs/incompatibilities with the shim. + ## Video Demos