From 4057e5c379f48c02f8997e307c607a9d4f0b5b85 Mon Sep 17 00:00:00 2001
From: pmakhov <pavel.makhov@savoirfairelinux.com>
Date: Mon, 9 Oct 2017 16:20:20 -0400
Subject: volumearc widget

---
 volumearc-widget/README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

(limited to 'volumearc-widget/README.md')

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,
+		...
+```
-- 
cgit v1.2.3