summaryrefslogtreecommitdiff
path: root/volumearc-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'volumearc-widget/README.md')
-rw-r--r--volumearc-widget/README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md
index 56f4c7c..702b486 100644
--- a/volumearc-widget/README.md
+++ b/volumearc-widget/README.md
@@ -1,2 +1,25 @@
# Volumearc widget
-:hammer: Work in progress...:construction:
+
+Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using arcchart:
+
+![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("volumearc")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ volumearc_widget,
+ ...
+```