From ef9f7e29ba829435da1a7290a8bdafb5ecf03299 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Fri, 31 May 2024 14:26:52 +0200 Subject: Prepare metadata for first publish --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) (limited to 'README.md') 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) -- cgit v1.3.1