docs: add readme

2025-04-03 09:50:59 +02:00 · 2025-04-03 09:50:59 +02:00 · 2976317d6e
parent 1c1160eb00
commit 2976317d6e
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,18 @@
+# notice
+
+Basic text-based D-Bus notification handler that outputs JSON compatible
+with Waybar.
+
+## waybar integration
+
+In `.config/waybar/config.jsonc`:
+
+```jsonc
+"custom/notifications": {
+    "format": "{}",
+    "max-length": 64,
+    "hide-empty-text": true,
+    "return-type": "json",
+    "exec": "/path/to/notice",
+}
+```