summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Cargo.toml4
-rw-r--r--LICENSE21
-rw-r--r--README.md22
3 files changed, 46 insertions, 1 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 8aa3940..adb293b 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,7 +1,11 @@
[package]
name = "somafm"
version = "0.1.0"
+authors = ["Yuval Adam <_@yuv.al>"]
edition = "2021"
+license = "MIT"
+keywords = ["radio", "somafm", "media"]
+repository = "https://github.com/yuvadm/somafm.rs"
[dependencies]
inquire = "0.7.5"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..583fd8a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yuval Adam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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)