From 2976317d6efbc7d6c81193d768ebf50a3f124dc02100680f0a6ff43bfda76116 Mon Sep 17 00:00:00 2001
From: Viktor Varland <varl@vlv.io>
Date: Thu, 3 Apr 2025 09:50:59 +0200
Subject: [PATCH] docs: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fa0cef3
--- /dev/null
+++ 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",
+}
+```