From 99d8fdc9b3627d526e500be2fac972b4c5069220 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Mon, 13 Jul 2015 23:07:30 +0200
Subject: Readme

---
 VolumeWidget/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 VolumeWidget/README.md

(limited to 'VolumeWidget/README.md')

diff --git a/VolumeWidget/README.md b/VolumeWidget/README.md
new file mode 100644
index 0000000..2c4a717
--- /dev/null
+++ b/VolumeWidget/README.md
@@ -0,0 +1,15 @@
+## Volume widget
+Simple and easy-to-install widget for Awesome Window Manager.
+
+This widget represents the sound level: ![Volume Wiget](./volWid.png)
+
+## Installation
+
+- clone/copy volume.lua file and volume-icons folder to your `~/home/username/.config/awesome/` folder;
+
+- include `volume.lua` and add volume widget to your wibox in rc.lua:
+```
+require("volume")
+...
+right_layout:add(volumeWidget)
+```
-- 
cgit v1.2.3