summaryrefslogtreecommitdiff
path: root/volumebar-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2017-09-06 14:00:29 -0400
committerGitHub <noreply@github.com>2017-09-06 14:00:29 -0400
commit7dc3c5d6f7acce7ca24062d1267d829480856569 (patch)
tree9fb489393f1811047364546d158dfb7c4f2c9f94 /volumebar-widget
parentcfba7aace45d0183b62ce7728d99b728dd93b6da (diff)
Update README.md
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,
+ ...
+ ```