summaryrefslogtreecommitdiff
path: root/volumebar-widget
diff options
context:
space:
mode:
Diffstat (limited to 'volumebar-widget')
-rw-r--r--volumebar-widget/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/volumebar-widget/README.md b/volumebar-widget/README.md
index 5b9ec54..8254b49 100644
--- a/volumebar-widget/README.md
+++ b/volumebar-widget/README.md
@@ -1 +1,25 @@
+# Volumebar widget
+
+Almost the same as volume widget, but more minimalistic:
+
![screenshot](out.gif)
+
+Supports
+ - scroll up - increase volume,
+ - scroll down - decrease volume,
+ - left click - mute/unmute.
+
+ ## Installation
+
+ Clone repo, include widget and use it in **rc.lua**:
+
+ ```lua
+ require("volumebar")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ volumebar_widget,
+ ...
+ ```