diff options
Diffstat (limited to 'battery-widget/README.md')
| -rw-r--r-- | battery-widget/README.md | 41 |
1 files changed, 34 insertions, 7 deletions
diff --git a/battery-widget/README.md b/battery-widget/README.md index 57f7c3f..710f8b2 100644 --- a/battery-widget/README.md +++ b/battery-widget/README.md @@ -4,17 +4,34 @@ Simple and easy-to-install widget for Awesome Window Manager. This widget consists of: - - an icon which shows the battery level: + - an icon which shows the battery level:  - - a pop-up window, which shows up when you hover over an icon: -  - Alternatively you can use a tooltip (check the code): + - a pop-up window, which shows up when you hover over an icon: +  + Alternatively you can use a tooltip (check the code):  - - a pop-up warning message which appears on bottom right corner when battery level is less that 15% (you can get the image [here](https://vk.com/images/stickers/1933/512.png)): -  + - a pop-up warning message which appears on bottom right corner when battery level is less that 15% (you can get the image [here](https://vk.com/images/stickers/1933/512.png)): +  Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder. +## Customization + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| `font` | Font | Play 8 | +| `show_current_level`| false | Show current charge level | +| `margin_right`|0| the right margin of the widget| +| `margin_left`|0| the left margin of the widget| +| `notification` | `false` | Display a notification on mouseover | +| `notification_position` | `top_right` | The notification position | +| `warning_msg_title` | _Huston, we have a problem_ | Title of the warning popup | +| `warning_msg_text` | _Battery is dying_ | Text of the warning popup | +| `warning_msg_position` | `bottom_right` | Position of the warning popup | +| `warning_msg_icon` | ~/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg | Icon of the warning popup | + ## Installation This widget reads the output of acpi tool. @@ -26,4 +43,14 @@ $ acpi Battery 0: Discharging, 66%, 02:34:06 remaining ``` -Then refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. +```lua +local battery_widget = require("awesome-wm-widgets.battery-widget.battery") + +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + battery_widget(), + ... +``` |