aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorclsr <clsr@clsr.net>2018-12-11 18:24:52 +0100
committerclsr <clsr@clsr.net>2018-12-11 18:31:16 +0100
commitcff36f68517806cd0ae28889d276012003d57012 (patch)
tree78cd0d6cdafdf76790f7e7a6ff882075f6f5bc7d /README.md
downloadff2mpv-go-cff36f68517806cd0ae28889d276012003d57012.tar.gz
ff2mpv-go-cff36f68517806cd0ae28889d276012003d57012.zip
Initial commitv1.0.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..821bf90
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+ff2mpv-go
+=========
+
+Native messaging host for [ff2mpv](https://github.com/woodruffw/ff2mpv/) written in Go.
+
+Since it is a native binary, it starts faster than the official Python or Ruby
+implementations.
+
+
+Requirements
+------------
+
+- [Firefox](https://www.mozilla.org/en-US/firefox/) 50 or later
+- [ff2mpv](https://github.com/woodruffw/ff2mpv/) 3.0 or later
+- [Go](https://golang.org/) 11 or later (probably works on older versions too)
+- [mpv](https://mpv.io/) 0.21.0 or later
+
+
+Installation
+------------
+
+- `go get git.clsr.net/util/ff2mpv-go`
+- `ff2mpv-go --manifest > ~/.mozilla/native-messaging-hosts/ff2mpv.json`
+
+If `$GOBIN` is not in `$PATH`, specify the full path to the installed
+executable (e.g. `$GOBIN/ff2mpv-go`) when running it.
+
+If a custom mpv command is required, manually clone the repository and edit the
+`mpvCmd` variable in `ff2mpv.go`, then `go install` the package instead of the
+`go get` step.
+
+
+Usage
+-----
+
+Use ff2mpv as normally.