global readme update

1 files changed, 101 insertions, 1 deletions

diff --git a/README.md b/README.md
index 7c5a7a3..93f99cc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,103 @@
 # AwesomeWM
 
-Some of my settings/widgets for Awesome which could be interesting for somebody.
+Set of simple widgets for Awesome Window Manager consists of following widgets:
+
+## Battery widget
+
+This widget consists of
+
+ - an icon which shows the battery status: ![Battery Widget](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/BatteryWidget/batWid1.png)
+ - a pop-up window, which shows up when you hover over it: ![Battery Widget](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/BatteryWidget/batWid2.png)
+ - a pop-up warning message which appears when battery level is less that 15%: ![Battery Widget](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/BatteryWidget/batWid3.png)
+
+**Installation**
+
+This widget uses the output of acpi tool.
+- install `acpi` tool:
+```
+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")
+...
+right_layout:add(batteryIcon)
+```
+
+---
+
+## Email widget
+
+This widget consists of an icon with counter which shows number of unread emails: ![email icon](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/EmailWidget/emailWidgetScrnsht.png)
+and a popup message which appears when mouse hovers over an icon: ![email popup](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/EmailWidget/emailWidgetScrnsht2.png)
+
+**Installation**
+
+To install it either clone [EmailWidget](https://github.com/streetturtle/AwesomeWM/tree/master/EmailWidget) project under `~/.config/awesome/` or download a .zip archive and unzip it there.
+
+After provide your credentials in python scripts so that they could connect to server and add following lines in your **rc.lua** file:
+
+```lua
+require("email")
+...
+right_layout:add(emailWidget_icon)
+right_layout:add(emailWidget_counter)
+```
+
+**How it works**
+
+This widget uses the output of two python scripts, first is called every 5 seconds - it returns number of unread emails and second is called when mouse hovers over an icon and displays content of those emails. For both of them you'll need to provide your credentials and imap server. For testing they can simply be called from console:
+
+``` bash
+python ~/.config/awesome/email/countUnreadEmails.py
+python ~/.config/awesome/email/readEmails.py
+```
+
+Note that getting number of unread emails could take some time, so instead of `pread` or `spawn_with_shell` functions I use DBus, you can read more about it in [this]({{site.url}}/2015/09/fix-awesome-freezes) post.
+
+---
+
+## Rates widget
+
+Rates widget showing currency rate for chosen currencies with pop-up appearing when mouse hovers over it.
+More about this widget in this two posts:
+ - http://pavelmakhov.com/2016/01/how-to-create-widget
+ - http://pavelmakhov.com/2016/01/how-to-create-widget-part-2  
+
+---
+
+## Spotify widget
+
+Widget displaying currently playing song by Spotify application:
+![screenshot](https://raw.githubusercontent.com/streetturtle/AwesomeWM/master/Spotify/screenshot.png)
+
+You can read more about spotify integration in this blog [post]( http://pavelmakhov.com/2016/02/awesome-wm-spotify).
+
+---
+
+## Volume control widget
+
+Simple and easy-to-install widget for Awesome Window Manager.
+This widget represents the sound level: ![Volume Wiget](https://github.com/streetturtle/AwesomeWM/raw/master/VolumeWidget/volWid.png)
+
+**Installation**
+
+- clone/copy volume.lua file and volume-icons folder to your `~/home/username/.config/awesome/` folder;
+
+- change path to the icons in `volume.lua`:
+
+```
+widget:set_image("/home/<username>/.config/awesome/volume-icons/" .. volumeLevel .. ".png")
+```
+
+- include `volume.lua` and add volume widget to your wibox in rc.lua:
+
+```
+require("volume")
+...
+right_layout:add(volumeWidget)
+```