From be9f44bb84fcaebf05229d77e5638b28329a8c4f Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 3 Oct 2024 14:24:39 +0200 Subject: Update documentation in README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 162e21e..8392f66 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ # soundbox-app -This is an app to use [soundbox][1] devices. +This is an app to use [soundbox][1] devices. The current version is only a web +radio player as a proof of concept. Future versions will add the audio +streaming to soundbox devices. [1]: https://xengineering.eu/git/soundbox ## Usage +The [Go tool][1] and the [mpv media player][2] are required to use the app. It +can be build and started like this: + ``` go run main.go ``` + +[1]: https://go.dev +[2]: https://mpv.io -- cgit v1.2.3-70-g09d2