summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2024-05-31 14:26:52 +0200
committerYuval Adam <_@yuv.al>2024-05-31 14:26:52 +0200
commitef9f7e29ba829435da1a7290a8bdafb5ecf03299 (patch)
treeb9d6d92792ea5c9b700eb878507c46b534c9c0dc /README.md
parenta0f73e088846ddc31e10b7ad25bd533c11a06a6f (diff)
Prepare metadata for first publish
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/README.md b/README.md
index 12dc9c0..55bf8f1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
# somafm.rs
-A Rust-based SomaFM command line client. \ No newline at end of file
+A Rust-based command line player for SomaFM radio
+
+Currently requires `mpv` installed as the media backend, pure-rust media output is planned.
+
+## Install
+
+```bash
+$ cargo install somafm
+```
+
+## Usage
+
+```bash
+$ somafm
+⠴ Loading SomaFM channels...
+> Select channel from list: Groove Salad: A nicely chilled plate of ambient/downtempo beats and grooves.
+```
+
+## License
+
+[MIT](LICENSE)