docs: update readme
readme has been updated with current installation methods, controls, and a contributor note. closes 7085a97
diff --git a/README.md b/README.md
@@ -1,35 +1,49 @@
# grrs (Gensokyo Radio Rust)
+> [!NOTE]
+> This project is currently in early, rapid development. If you are planning to contribute or submit patches, please open an issue first to discuss your ideas so we don't step on each other's toes!
+
A minimal terminal user interface for [Gensokyo Radio](https://gensokyoradio.net/), written in Rust.
-## Features
-- Real-time music playback and metadata streaming
-- Album art rendering
-- Local library to save and manage liked tracks
-- MPRIS integration
-- Live listener count
-- Simple base16 accent cycling
+## What it does
+- Streams Gensokyo Radio with album art in your terminal
+- Lets you save liked tracks and keeps local copies of their metadata and covers
+- Supports media keys (MPRIS) and volume controls
+- Rudimentary theming support via base16 cycling accents
## Dependencies
- `mpv`: Required for the underlying audio streaming and playback.
## Installation
+
+### From Crates.io
+```sh
+cargo install myn-grrs
+```
+
+### From Source (Radicle)
```sh
-cargo build --release
-./target/release/grrs
+git clone https://seed.radicle.xyz/rad:z3dnwE7h9y4ndGdqeafNLP8eDPn3Y.git grrs
+(cd grrs && cargo install --path .)
+```
+
+### With Nix
+You can run it directly without installing:
+```sh
+nix run "git+rad://z3dnwE7h9y4ndGdqeafNLP8eDPn3Y#grrs"
```
## Controls
- `l` - Like/Unlike current song
- `m` - Mute/Unmute stream
+- `-`/`=` - Volume down/up
+- `c` - Copy track name/artist to clipboard
+- `C` - Copy full track metadata to clipboard
- `t` - Cycle theme colors
-- `Enter` - Open detailed song info
-- `Tab` - Switch between the liked library and active player
+- `Enter` - Open detailed song info in library
+- `Tab` - Switch between the library and player
- `?` - Show the help menu
- `q/^c` - Quit
## Disclaimer
-
This is one of my first real projects using Rust. A significant portion of this codebase was co-written with the help of Gemini 3.1 Pro. While it works great for my use-case, the internals might not be the best Rust you've ever seen.
-
-I don't really plan to actively maintain this project, but if issues and PRs come up, I'll try to address them. My main goal was simply to get a working TUI rolling for Gensokyo Radio. If you like the concept and want to improve the code or add features, I encourage you to feel free to fork it and make it your own!