diff --git a/Cargo.lock b/Cargo.lock index 432afa0..0008134 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -29,8 +29,8 @@ dependencies = [ ] [[package]] -name = "lystra" -version = "0.1.3" +name = "lizzy" +version = "0.1.4" dependencies = [ "dbus", "pico-args", diff --git a/Cargo.toml b/Cargo.toml index ce9c6d2..8666607 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] -name = "lystra" -version = "0.1.3" +name = "lizzy" +version = "0.1.4" edition = "2021" [profile.release] diff --git a/README.md b/README.md index 1382096..3015dd4 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# Lystra +# lizzy -Lystra is a simple and small app that lets [Waybar](https://github.com/Alexays/Waybar) display what you're currently listening to by using DBus signals instead of polling. +Lizzy is a simple and small app that lets [Waybar](https://github.com/Alexays/Waybar) display what song or media is playing by listening to DBus signals instead of polling. ## Features - Customizable output format, including colors (see Usage below) - Support for any [MPRIS](https://wiki.archlinux.org/title/MPRIS) mediaplayer of preference - Automatic pause/resume when other media content begins/stops playing (ex. YouTube videos) - Clearing of output when mediaplayer is closed -- No constant polling, Lystra only updates when a signal is received +- No constant polling, lizzy only updates when a signal is received Some examples of its output here:
@@ -16,14 +16,14 @@ Some examples of its output here:
## Installation from source
1. Make sure you've got Rust installed. Either via your distributions package manager or [`rustup`](https://rustup.rs/).
-2. `cargo install --git https://github.com/stefur/lystra lystra`
+2. `cargo install --git https://github.com/stefur/lizzy lizzy`
## Configure Waybar
Add a custom module to your Waybar config, something like:
```
-"custom/lystra": {
+"custom/lizzy": {
"format": "{icon} {}"
- "exec": "lystra",
+ "exec": "lizzy",
"return-type": "json"
"format-icons": {
"Playing": "",
@@ -32,18 +32,18 @@ Add a custom module to your Waybar config, something like:
"max-length": 45
}
```
-Add whatever flags you want to the command in `exec`, for example something like: `"exec": "lystra --format '{{title}}: {{artist}}' --autotoggle"`
+Add whatever flags you want to the command in `exec`, for example something like: `"exec": "lizzy --format '{{title}}: {{artist}}' --autotoggle"`
Don't forget to add the module to your bar!
## Usage
-Currently the following options can be used to customize the output of Lystra.
+Currently the following options can be used to customize the output of lizzy.
| Flag | Default value | Description |
| --- | --- | --- |
| `--format` | "{{artist}} - {{title}}" | Format of output, using handlebar tags. |
-| `--mediaplayer`| None | Mediaplayer interface that Lystra should listen to. Usually the name of the mediaplayer. Blank means listening to all mediaplayers. |
+| `--mediaplayer`| None | Mediaplayer interface that lizzy should listen to. Usually the name of the mediaplayer. Blank means listening to all mediaplayers. |
| `--autotoggle` | False | Include this flag to automatically pause/resume the mediaplayer if other media content playing is detected (for example a YouTube video) |
## Example
-`lystra --format '{{title}} by {{artist}}' --mediaplayer 'spotify' --autotoggle`
+`lizzy --format '{{title}} by {{artist}}' --mediaplayer 'spotify' --autotoggle`
diff --git a/src/main.rs b/src/main.rs
index 6d0e2da..c7767d1 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -81,7 +81,7 @@ fn main() -> Result<(), Box