summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-10-03 14:24:39 +0200
committerxengineering <me@xengineering.eu>2024-10-03 14:24:39 +0200
commitbe9f44bb84fcaebf05229d77e5638b28329a8c4f (patch)
tree5042e982d03557b26363142566fcc03de49475ee
parent64323e11c37c5d8f6acef60a33c8189cc469a73f (diff)
downloadsoundbox-app-be9f44bb84fcaebf05229d77e5638b28329a8c4f.tar
soundbox-app-be9f44bb84fcaebf05229d77e5638b28329a8c4f.tar.zst
soundbox-app-be9f44bb84fcaebf05229d77e5638b28329a8c4f.zip
Update documentation in README.md
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
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