From 54dcac02e69545743c4cb07942428e4fdaea515e Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Sat, 22 Aug 2020 15:40:24 +0100 Subject: Add flags, executable and improve README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8ae1301..a527fb3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ ## waybar-mpris -a custom waybar component for displaying info from MPRIS2 players. Currently WIP. +a custom waybar component for displaying info from MPRIS2 players. It automatically focuses on currently playing music players, and can easily be customized. + +## Usage +When running, the program will pipe out json in waybar's format. Make a custom component in your configuration and set `return-type` to `json`, and `exec` to the path to the program. +``` +Usage of ./waybar-mpris: + --order string Element order. (default "SYMBOL:ARTIST:ALBUM:TITLE") + --pause string Pause symbol/text to use. (default "") + --play string Play symbol/text to use. (default "▶") + --separator string Separator string to use between artist, album, and title. (default " - ") +``` +* Modify the order of components with `--order`. `SYMBOL` is the play/paused icon or text, other options are self explanatory. +* `--play/--pause` specify the symbols or text to display when music is paused/playing respectively. +* --separator specifies a string to separate the artist, album and title text. + -- cgit v1.2.3