summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index c9cbb06..1fc718d 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
# soundbox-go
-[soundbox-go][1] is a Go library to interface with [soundbox][2] devices.
+[soundbox-go][1] is a Go library to interface with [soundbox][2] devices. It
+currently requires that the [ffmpeg][3] command line utility is installed.
While the repository and project name is `soundbox-go` the Go module name is
only `soundbox` to make the resulting code more readable.
[1]: https://xengineering.eu/git/soundbox-go
[2]: https://xengineering.eu/git/soundbox
+[3]: https://ffmpeg.org