From e214e416d3ce53dec14e5f0e81ceae587f1fd4bc Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Wed, 1 Feb 2017 21:25:25 -0500
Subject: screenshots and readme

---
 volume-widget/README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 volume-widget/README.md

(limited to 'volume-widget/README.md')

diff --git a/volume-widget/README.md b/volume-widget/README.md
new file mode 100644
index 0000000..99d3ad8
--- /dev/null
+++ b/volume-widget/README.md
@@ -0,0 +1,31 @@
+# Volume widget
+
+Simple and easy-to-install widget for Awesome Window Manager.
+
+This widget represents the sound level: ![Volume Wiget](./vol-wid-1.png)
+
+## Installation
+
+- clone/copy **volume.lua** file;
+
+- include `volume.lua` and add volume widget to your wibox in rc.lua:
+
+```lua
+require("volume")
+...
+s.mytasklist, -- Middle widget
+	{ -- Right widgets
+    	layout = wibox.layout.fixed.horizontal,
+		...
+		volume_widget,
+		...      
+```
+
+## Control volume
+
+To be able to control volume level add following lines in shortcut section of the **rc.lua** (the command 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"}),
+```
\ No newline at end of file
-- 
cgit v1.2.3