Battery widget readme

6 files changed, 48 insertions, 5 deletions

diff --git a/README.md b/README.md
index aa2e212..dc9c91e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
 # AwesomeWM
 
-Set of simple widgets compatible with Awesome Window Manager v.4.
+Set of super simple widgets compatible with Awesome Window Manager v.4.
 
-Coming soon
+![screenshot](https://github.com/streetturtle/AwesomeWM/blob/master/screenshot.png?raw=true)
+
+Consists of:
 
 - [battery-widget](https://github.com/streetturtle/AwesomeWM/tree/master/battery-widget)
 - [brightness-widget](https://github.com/streetturtle/AwesomeWM/tree/master/brightness-widget)
@@ -10,3 +12,10 @@ Coming soon
 - [rhythmbox-widget](https://github.com/streetturtle/AwesomeWM/tree/master/rhythmbox-widget)
 - [spotify-widget](https://github.com/streetturtle/AwesomeWM/tree/master/spotify-widget)
 - [volume-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volume-widget)
+
+These widgets use [Arc icon theme](https://github.com/horst3180/arc-icon-theme) by default but it could be easily changed to any other icon theme.
+
+# Installation
+
+[Install](https://github.com/horst3180/arc-icon-theme#installation) Arc icon theme.
+Follow installation instruction of each widget:
diff --git a/battery-widget/README.md b/battery-widget/README.md
new file mode 100644
index 0000000..eee4e99
--- /dev/null
+++ b/battery-widget/README.md
@@ -0,0 +1,34 @@
+# Battery widget
+Simple and easy-to-install widget for Awesome Window Manager.
+
+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)
+ - a pop-up warning message which appears on bottom right corner when battery level is less that 15%: ![Battery Widget](./bat-wid-3.png) 
+
+## Installation
+
+This widget reads the output of acpi tool.
+- install `acpi` and check the output:
+
+```bash
+$ sudo apt-get install acpi
+$ acpi
+Battery 0: Discharging, 66%, 02:34:06 remaining
+```
+
+- clone/copy battery.lua file to ~/.config/awesome/ folder;
+
+- include `battery.lua` and add battery widget to your wibox in rc.lua:
+
+```lua
+require("battery")
+...
+s.mytasklist, -- Middle widget
+	{ -- Right widgets
+    	layout = wibox.layout.fixed.horizontal,
+		...
+		battery_widget,
+		...      
+```
\ No newline at end of file
diff --git a/battery-widget/bat-wid-1.png b/battery-widget/bat-wid-1.png
new file mode 100644
index 0000000..00e1618
--- /dev/null
+++ b/battery-widget/bat-wid-1.png
diff --git a/battery-widget/bat-wid-2.png b/battery-widget/bat-wid-2.png
new file mode 100644
index 0000000..ae20af2
--- /dev/null
+++ b/battery-widget/bat-wid-2.png
diff --git a/battery-widget/bat-wid-3.png b/battery-widget/bat-wid-3.png
new file mode 100644
index 0000000..352b496
--- /dev/null
+++ b/battery-widget/bat-wid-3.png
diff --git a/battery-widget/battery.lua b/battery-widget/battery.lua
index 14fef67..c34c235 100644
--- a/battery-widget/battery.lua
+++ b/battery-widget/battery.lua
@@ -3,7 +3,7 @@ local awful = require("awful")
 local naughty = require("naughty")
 local watch = require("awful.widget.watch")
 
-batteryIcon = wibox.widget { widget = wibox.widget.imagebox }
+battery_widget = wibox.widget { widget = wibox.widget.imagebox }
 
 -- acpi sample outputs
 -- Battery 0: Discharging, 75%, 01:51:38 remaining
@@ -28,7 +28,7 @@ watch(
         if status == 'Charging' then 
             batteryType = batteryType .. '-charging'
         end
-        batteryIcon.image = path_to_icons .. batteryType .. ".svg"
+        battery_widget.image = path_to_icons .. batteryType .. ".svg"
     end
 )
 
@@ -58,4 +58,4 @@ function show_battery_warning()
 end
 
 -- popup with battery info
-batteryIcon:connect_signal("mouse::enter", function() show_battery_status() end)
\ No newline at end of file
+battery_widget:connect_signal("mouse::enter", function() show_battery_status() end)
\ No newline at end of file