From ed8bd0a96a353d309ca5d9750d8ce0919db6a7c8 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Sat, 13 Apr 2019 22:44:47 -0400
Subject: update volumebar widget

---
 volumebar-widget/README.md | 61 ++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 51 insertions(+), 10 deletions(-)

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

diff --git a/volumebar-widget/README.md b/volumebar-widget/README.md
index d6b9117..92beee2 100644
--- a/volumebar-widget/README.md
+++ b/volumebar-widget/README.md
@@ -9,21 +9,62 @@ Supports
  - scroll down - decrease volume, 
  - left click - mute/unmute.
  
- ## Installation
+ ## Customization
  
- Clone repo, include widget and use it in **rc.lua**:
+ It is possible to customize widget by providing a table with all or some of the following config parameters:
  
  ```lua
-local volumebar_widget = require("awesome-wm-widgets.volumebar-widget.volumebar")
-...
-s.mytasklist, -- Middle widget
-	{ -- Right widgets
-    	layout = wibox.layout.fixed.horizontal,
-		...
-		volumebar_widget,
-		...      
+ volumebar_widget({
+    main_color = '#af13f7',
+    mute_color = '#ff0000',
+    width = 80,
+    shape = 'rounded_bar', -- octogon, hexagon, powerline, etc
+    -- bar's height = wibar's height minus 2x margins
+    margins = 8
+})
  ```
 
+Above config results in following widget:
+
+![custom](./custom.png) 
+
+
+ ## Installation
+ 
+1. Clone this repo under **~/.config/awesome/**
+
+    ```bash
+    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+    ```
+
+1. Require volumebar widget at the beginning of **rc.lua**:
+
+    ```lua
+    local volumebar_widget = require("awesome-wm-widgets.volumebar-widget.volumebar")
+    ```
+
+1. Add widget to the tasklist:
+
+    ```lua
+    s.mytasklist, -- Middle widget
+        { -- Right widgets
+            layout = wibox.layout.fixed.horizontal,
+            ...
+            --[[default]]
+            volumebar_widget(),
+            --[[or customized]]
+            volumebar_widget({
+                main_color = '#af13f7',
+                mute_color = '#ff0000',
+                width = 80,
+                shape = 'rounded_bar', -- octogon, hexagon, powerline, etc
+                -- bar's height = wibar's height minus 2x margins
+                margins = 8
+            }),
+
+            ...
+    ```
+
 ## Troubleshooting
 
 If the bar is not showing up, try to decrease top or bottom margin - widget uses hardcoded margins for vertical alignment, so if your wibox is too small then bar is simply hidden by the margins.
-- 
cgit v1.2.3