summaryrefslogtreecommitdiff
path: root/volumearc-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2019-04-13 20:51:54 -0400
committerstreetturtle <streetturtle@gmail.com>2019-04-13 20:52:16 -0400
commitc40075136423a5602d27325a1366c371acfe801c (patch)
treef2b4871e0256262d526a4faa3f31808c344ec96c /volumearc-widget/README.md
parentcf75c446e10ebf720df114e1d040a5c4730c21c3 (diff)
update volumearc readme
Diffstat (limited to 'volumearc-widget/README.md')
-rw-r--r--volumearc-widget/README.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md
index 79f519d..5bd8e83 100644
--- a/volumearc-widget/README.md
+++ b/volumearc-widget/README.md
@@ -4,6 +4,24 @@ Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm
![screenshot]({{'/assets/img/screenshots/volumearc-widget.gif' | relative_url }}){:.center-image}
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+```lua
+volumearc_widget({
+ main_color = '#af13f7',
+ mute_color = '#ff0000',
+ path_to_icon = '/usr/share/icons/Papirus-Dark/symbolic/status/audio-volume-high-symbolic.svg',
+ thickness = 5,
+ height = 25
+})
+```
+
+Above config results in following widget:
+
+![custom](./custom.png)
+
## Installation
1. Clone this repo under **~/.config/awesome/**
@@ -29,12 +47,12 @@ Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm
volumearc_widget(),
--[[or customized]]
volumearc_widget({
- main_color = '#0000ff',
+ main_color = '#af13f7',
mute_color = '#ff0000',
- path_to_icon = '/usr/share/icons/Arc/actions/symbolic/view-grid-symbolic.svg',
+ path_to_icon = '/usr/share/icons/Papirus-Dark/symbolic/status/audio-volume-high-symbolic.svg',
thickness = 5,
height = 25
}),
...
- ``` \ No newline at end of file
+ ```