summaryrefslogtreecommitdiff
path: root/BatteryWidget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2015-07-18 13:31:59 +0200
committerstreetturtle <streetturtle@gmail.com>2015-07-18 13:31:59 +0200
commit50285d43173ca48e1b618d9d2146191a47cb9811 (patch)
tree987a2ac417f91b851308257ce7ccbe17dd084e12 /BatteryWidget/README.md
parentb934547d383e6d21b06fa11e024aad880f38db54 (diff)
update readme
Diffstat (limited to 'BatteryWidget/README.md')
-rw-r--r--BatteryWidget/README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/BatteryWidget/README.md b/BatteryWidget/README.md
index fa3925e..8ffa364 100644
--- a/BatteryWidget/README.md
+++ b/BatteryWidget/README.md
@@ -1,9 +1,11 @@
## Battery widget
Simple and easy-to-install widget for Awesome Window Manager.
-Basically this widget consists of an icon which shows the battery status: ![Battery Widget](./batWid1.png)
+This widget consists of
-And a pop-up window, which shows up when you hover over it: ![Battery Widget](./batWid2.png)
+ - an icon which shows the battery status: ![Battery Widget](./batWid1.png)
+ - a pop-up window, which shows up when you hover over it: ![Battery Widget](./batWid2.png)
+ - a pop-up warning message which appears when battery level is less that 15%.
## Installation
@@ -14,6 +16,8 @@ sudo apt-get install acpi
```
- clone/copy battery.lua file and battery-icons folder to your ~/home/username/.config/awesome/ folder;
+- change path to the icons in `battery.lua`;
+
- include `battery.lua` and add battery widget to your wibox in rc.lua:
```
require("battery")