From 5a0ff019f573abe7519fce33d095b0eed6a5f13c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Carlos=20Cuevas?= Date: Tue, 5 Dec 2023 16:06:39 +0100 Subject: [PATCH] chore: Update README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8fcc6a8..be75116 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -# radiospiral_linux +# RadioSpiral Player for GNU/Linux -RadioSpiral client written in Golang, for native Linux support. - -It use Flyte as the GUI and MPlayer as the backend to stream from the radio. \ No newline at end of file +This is the official native GNU/Linux application to listen to RadioSpiral and keep informed +about the upcoming shows. Self contained app, just requiring having MPlayer installed on the +system. + +It uses Flyte as the GUI and MPlayer as the backend to stream from the radio. + +## Installation + +Just put it in your path or copy to `$HOME/.local/bin` (ensure that it is in your path!). + +## Running + +Launch the application and press play, that's all. You can pause the stream and control the +volume with the buttons provided for that and the application will update itself to show you +what's playing and the next live show for the radio.