add README.md

Author: elliotcubit

COPYING

@@ -2,6 +2,11 @@
 name = "polybar-mpris-watcher-rs"
 version = "1.0.0"
 edition = "2024"
+license = "GPL-3.0-or-later"
+description = "A good music status display for polybar"
+repository = "github.com/elliotcubit/polybar-mpris-watcher-rs"
+readme = "README.md"
+keywords = ["polybar", "mpris", "music", "module"]
 
 [dependencies]
 clap = { version = "4.5.41", features = ["derive"] }

Cargo.lock

@@ -0,0 +1,42 @@
+# polybar-mpris-watcher-rs
+
+A good music status display for polybar.
+
+It uses DBus to display the currently playing media. The text size and scrolling rate are configurable.
+
+It supports extended unicode characters, parsing them by grapheme cluster.
+
+# Demo
+
+![demo](assets/demo.gif)
+![demo](assets/demo2.gif)
+
+# Installation
+
+`polybar-mpris-watcher-rs` is available on crates.io, and can be installed via `cargo`:
+
+```
+$ cargo install polybar-mpris-watcher-rs
+```
+
+You will need to add a polybar module which uses the installed binary. This is where configuration is done.
+
+```
+[module/music]
+type = custom/script
+exec = "polybar-mpris-watcher-rs -u 2000 -b 25"
+tail = true
+```
+
+Add the module wherever in your polybar, e.g. in the middle:
+
+```
+modules-center = music
+```
+
+# Font debugging
+
+If you have trouble with some characters not displaying, give the polybar wiki [page on fonts](https://github.com/polybar/polybar/wiki/Fonts) a read.
+
+
+

Cargo.toml

@@ -1,3 +1,20 @@
+// Copyright 2025 Elaine Cubit
+//
+// This file is part of polybar-mpris-watcher-rs.
+//
+// polybar-mpris-watcher-rs is free software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or (at your
+// option) any later version.
+//
+// polybar-mpris-watcher-rs is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program. If not, see <https://www.gnu.org/licenses/>. 
+
 mod watcher;
 
 use crate::watcher::Watcher;

README.md

@@ -1,3 +1,20 @@
+// Copyright 2025 Elaine Cubit
+//
+// This file is part of polybar-mpris-watcher-rs.
+//
+// polybar-mpris-watcher-rs is free software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or (at your
+// option) any later version.
+//
+// polybar-mpris-watcher-rs is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program. If not, see <https://www.gnu.org/licenses/>. 
+
 use std::{
     thread,
     time,