From 429e6eb54a5bab17d7adba8956fcbc0a63257ed5 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Thu, 2 May 2019 21:35:30 -0400
Subject: external config for brightness and brightnessarc

---
 brightnessarc-widget/README.md | 63 +++++++++++++++++++++++++++++++++---------
 1 file changed, 50 insertions(+), 13 deletions(-)

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

diff --git a/brightnessarc-widget/README.md b/brightnessarc-widget/README.md
index fa123c1..d122d3a 100644
--- a/brightnessarc-widget/README.md
+++ b/brightnessarc-widget/README.md
@@ -1,12 +1,32 @@
 # Brightness widget
 
-![Brightness widget](./br-wid-1.png)
+This widget represents current brightness level: ![Brightness widget](./br-wid-1.png)
+
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `get_brightness_cmd` | `light -G` | Get current screen brightness |
+| `inc_brightness_cmd` | `light -A 5` | Increase brightness |
+| `dec_brightness_cmd` | `light -U 5`| Decrease brightness |
+| `path_to_icon` | `/usr/share/icons/Arc/status/symbolic/display-brightness-symbolic.svg` | Path to the icon |
+
+### Example:
+
+```lua
+brightnessarc_widget({
+    get_brightness_cmd = 'xbacklight -get',
+    inc_brightness_cmd = 'xbacklight -inc 5',
+    dec_brightness_cmd = 'xbacklight -dec 5'
+})
+```
 
-This widget represents current brightness level.
 
 ## Installation
 
-Firstly you need to get the current brightness level. There are two options:
+First you need to get the current brightness level. There are two options:
 
  - using `xbacklight` command (depending on your video card (I guess) it may or may not work)
  
@@ -30,19 +50,36 @@ Firstly you need to get the current brightness level. There are two options:
     light -G
     49.18
     ```
-Depending on the chosen option change `GET_BRIGHTNESS_CMD` variable in **brightness.lua**.
 
-Then in **rc.lua** add the import on top of the file and then add widget to the wibox:
+Then clone this repo under **~/.config/awesome/**:
+
+```bash
+git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+```
+
+Require widget at the beginning of **rc.lua**:
+
+```lua
+local brightness_widget = require("awesome-wm-widgets.brightness-widget.brightness")
+```
+
+Add widget to the tasklist:
 
 ```lua
-require("awesome-wm-widgets.brightness-widget.brightness")
-...
--- Add widgets to the wibox
-s.mywibox:setup {
-...
-{ -- Right widgets
-...
-brightness_widget
+s.mytasklist, -- Middle widget
+    { -- Right widgets
+        layout = wibox.layout.fixed.horizontal,
+        ...
+        -- default
+        brightnessarc_widget(),
+        -- or customized
+        brightnessarc_widget({
+          get_brightness_cmd = 'xbacklight -get',
+          inc_brightness_cmd = 'xbacklight -inc 5',
+          dec_brightness_cmd = 'xbacklight -dec 5'
+        })      
+    }
+        ...
 ```
 
 ## Controls
-- 
cgit v1.2.3