update from master

_widgets/batteryarc-widget.md

@@ -37,6 +37,11 @@ It is possible to customize widget by providing a table with all or some of the
 | `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 |
 
+## Requirements
+
+This widget requires the `acpi` command to be available to retrieve battery and
+power information.
+
 ## Installation
 
 Clone repo, include widget and use it in **rc.lua**:

_widgets/todo-widget.md

@@ -0,0 +1,24 @@
+---
+layout: page
+---
+# ToDo Widget (in progress)
+
+This widgets displays a list of to do items and allows to mark item as done, delete item and create new ones:
+
+![screenshot](../awesome-wm-widgets/assets/img/screenshots/todo-widget/todo.gif)
+
+# Installation
+
+Clone repo under **~/.config/awesome/** and add the widget in **rc.lua**:
+
+```lua
+local todo_widget = require("awesome-wm-widgets.todo-widget.todo")
+...
+s.mytasklist, -- Middle widget
+	{ -- Right widgets
+    	layout = wibox.layout.fixed.horizontal,
+		...
+        -- default        
+        todo_widget(),
+		...      
+```

_widgets/volume-widget.md

@@ -13,9 +13,9 @@ It is possible to customize widget by providing a table with all or some of the
 
 | Name | Default | Description |
 |---|---|---|
-| `volume_audio_controller` | `pulse` | audio device |
+| `volume_audio_controller`| `pulse`    | audio device |
-| `display_notification` | `false` | Display a notification on mouseover |
+| `display_notification`   | `false`    | Display a notification on mouseover and keypress |
-| `notification_position` | `top_right` | The notification position |
+| `notification_position`  | `top_right`| The notification position |
 
 ## Installation
 
@@ -24,15 +24,46 @@ It is possible to customize widget by providing a table with all or some of the
 - include `volume.lua` and add volume widget to your wibox in rc.lua:
 
 ```lua
-require("volume")
+local volume_widget = require("awesome-wm-widgets.volume-widget.volume")
 ...
-s.mytasklist, -- Middle widget
+        s.mytasklist, -- Middle widget
-	{ -- Right widgets
+        { -- Right widgets
-    	layout = wibox.layout.fixed.horizontal,
+           ...
-		...
+            volume_widget({display_notification = true}),
-		volume_widget(),
+           ...
-		...
+
 ```
+### Control volume
+
+To mute/unmute click on the widget. To increase/decrease volume scroll up or down when mouse cursor is over the widget.
+
+If you want to control volume level by keyboard shortcuts add following lines in shortcut section of the **rc.lua**:
+IF you have notification activated, a notification will pop-up on key press
+
+```lua
+--  Key bindings
+globalkeys = gears.table.join(
+  awful.key(
+    {},
+    'XF86AudioRaiseVolume',
+    volume_widget.raise,
+    {description = 'volume up', group = 'hotkeys'}
+  ),
+  awful.key(
+    {},
+    'XF86AudioLowerVolume',
+    volume_widget.lower,
+    {description = 'volume down', group = 'hotkeys'}
+  ),
+  awful.key(
+    {},
+    'XF86AudioMute',
+    volume_widget.toggle,
+    {description = 'toggle mute', group = 'hotkeys'}
+  ),
+```
+
+### Icons
 
 - _Optional step._ In Arc icon theme the muted audio level icon (![Volume-widget](../awesome-wm-widgets/assets/img/screenshots/volume-widget/audio-volume-muted-symbolic.png)) looks like 0 level icon, which could be a bit misleading.
  So I decided to use original muted icon for low audio level, and the same icon, but colored in red for muted audio level. Fortunately icons are in svg format, so you can easily recolor them with `sed`, so it would look like this (![Volume Widget](../awesome-wm-widgets/assets/img/screenshots/volume-widget/audio-volume-muted-symbolic_red.png)):
@@ -77,17 +108,3 @@ volume_widget({
     volume_audio_controller = 'alsa_only'
 })
 ```
-
-.
-
-## Control volume
-
-To mute/unmute click on the widget. To increase/decrease volume scroll up or down when mouse cursor is over the widget.
-
-If you want to control volume level by keyboard shortcuts add following lines in shortcut section of the **rc.lua** (the commands could be slightly different depending on your PC configuration):
-
-```lua
-awful.key({ modkey}, "[", function () awful.spawn("amixer -D pulse sset Master 5%+") end, {description = "increase volume", group = "custom"}),
-awful.key({ modkey}, "]", function () awful.spawn("amixer -D pulse sset Master 5%-") end, {description = "decrease volume", group = "custom"}),
-awful.key({ modkey}, "\", function () awful.spawn("amixer -D pulse set Master +1 toggle") end, {description = "mute volume", group = "custom"}),
-```