README added

1 files changed, 30 insertions, 0 deletions

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
+```