aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9311a6b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# pulse-volume-monitor
+
+`pulse-volume-monitor` is a simple C++ program that listens to PulseAudio's sink and source events and emits DBus signals `sinkChanged` and `sourceChanged` when something has been changed (volume, sink or source muted, etc).
+
+For use with AwesomeWM in volume indicator widget.
+
+### Usage
+`./pulse-volume-monitor dbus` or `./pulse-volume-monitor stdout` (for debugging)
+
+### AwesomeWM LUA example
+
+```
+dbus.request_name("session", "com.ch1p.pvm")
+dbus.add_match("session", "interface='com.ch1p.pvm',member='sinkChanged'")
+dbus.add_match("session", "interface='com.ch1p.pvm',member='sourceChanged'")
+dbus.connect_signal("com.ch1p.pvm",
+ function(info)
+ -- info.member is "sinkChanged" or "sourceChanged"
+ -- your code here
+ end
+)
+```