From 944e4af11b12fd2f8f8dfd861e245f65706fa1c9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=96zg=C3=BCr=20Kesim?= <oec@codeblau.de>
Date: Sat, 5 Feb 2022 13:02:09 +0100
Subject: [PATCH] README added

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b80a846
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Simple PulseAudio volume monitor
+
+This little monitor is my attempt to read the current volume and mute setting
+of the default sink from PulseAudio and make it accessible to xmobar:
+
+```haskell
+Config { commands = [
+                    , Run CommandReader "puvol-cont" "Vol"
+                    ]
+       , template = "%XMonadLog% }{ \
+           \│ <action=`alacritty -t pamix -e pamix` button=1>%Vol%</action> \
+           \│ %date% "
+```
+
+If it is called as `puvol-cont` it will wait for updates form PulseAudio, read
+the current value of the mute and volume states and write an output line to
+stdout.
+
+## Installation
+
+```shell
+go install kesim.org/puvol
+```
+
+For the continous mode you have to copy or add an symbolic link with name `puvol-cont`:
+
+```shell
+cd /path/to/bin/dir
+ln -s puvol puvol-cont
+```