summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpmakhov <pavel.makhov@savoirfairelinux.com>2017-10-04 15:16:16 -0400
committerpmakhov <pavel.makhov@savoirfairelinux.com>2017-10-04 15:16:16 -0400
commit35bdba1e4a7a9e032a4346efea94f5f36fe42f2c (patch)
tree3f3dc19e636853895ce1bc0245c513c8f072ecc6
parentf6fbb8fd35b50dcbbd057ffdeea7e73a0c56aa2b (diff)
parentdd917a1cb3c1e5112f5b508260558f3f5b5adfbc (diff)
Merge branch 'master' of https://github.com/streetturtle/awesome-wm-widgets
-rw-r--r--battery-widget/README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/battery-widget/README.md b/battery-widget/README.md
index 63b735a..4c907a1 100644
--- a/battery-widget/README.md
+++ b/battery-widget/README.md
@@ -1,15 +1,22 @@
# Battery widget
+
Simple and easy-to-install widget for Awesome Window Manager.
-This widget consists of
+This widget consists of:
- - an icon which shows the battery level: ![Battery Widget](./bat-wid-1.png)
- - a pop-up window, which shows up when you hover over an icon: ![Battery Widget](./bat-wid-2.png).
- Alternatively you can use a tooltip: ![Battery Widget](./bat-wid-22.png)
- - a pop-up warning message which appears on bottom right corner when battery level is less that 15%: ![Battery Widget](./bat-wid-3.png)
+ - an icon which shows the battery level:
+ ![Battery Widget](./bat-wid-1.png)
+ - a pop-up window, which shows up when you hover over an icon:
+ ![Battery Widget](./bat-wid-2.png)
+ Alternatively you can use a tooltip:
+ ![Battery Widget](./bat-wid-22.png)
+ - a pop-up warning message which appears on bottom right corner when battery level is less that 15%:
+ ![Battery Widget](./bat-wid-3.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.
+Also it's worth mentioning that if the charge is more that 95% the widget is hidden. This is done intentionally in order to save some space on wibox when laptop is plugged in dock station or power socket. You can edit this behaviour [here](https://github.com/streetturtle/awesome-wm-widgets/blob/41b0476d84646fe04b5795e072f5ac8dfdb0066b/battery-widget/battery.lua#L37)
+
## Installation
This widget reads the output of acpi tool.