From 8dff0ace5f6b6212003771303d69884088771382 Mon Sep 17 00:00:00 2001 From: Patrick Wicki Date: Wed, 4 Nov 2020 00:44:32 +0100 Subject: [PATCH] Create README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..21fd500 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# barify +Modify volume or brightness and display result as a bar via notifications (either dunst or mako). + +### Installation +* Just throw the script somewhere and make sure it's in your $PATH. +* There's also an [AUR package](https://aur.archlinux.org/packages/barify). + +Barify automatically uses either [mako](https://github.com/emersion/mako) or [dunst](https://github.com/dunst-project/dunst), +depending on which one it detects as running. + +On mako, for now, barify simply kills existing notifications and places a new one, which is admittedly ugly. +This will be fixed as soon as mako supports replacing notifications by their IDs (e.g. https://github.com/emersion/mako/pull/270). + +### Usage + + Usage: barify MODE ACTION + Modify volume or brightness and indicate level as + a bar via notifications (either dunst or mako). + + Example: + + barify vol up + + Arguments: + MODE: + Volume: volume|vol|v + Brightness: brightness|bright|b + ACTION: + Increase: up|u|inc|i + Decrease: down|dec|d + Mute: mute|m +