From ac49191802ada10deac71fe0ad2f9bf33099d8a5 Mon Sep 17 00:00:00 2001
From: Caroline Larimore <caroline@larimo.re>
Date: Tue, 13 May 2025 20:26:12 -0700
Subject: Add basic documentation

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 80af138..c37ab80 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
 # corvid
 
-A DBus Notification server that outputs JSON. Intended for use with [eww](https://github.com/elkowar/eww). I may eventually actually document this, but it's fairly simple.
\ No newline at end of file
+a dbus notification server that outputs json. intended for use with [eww](https://github.com/elkowar/eww).
+
+## subcommands
+- `server`: run the server
+- `dismiss <id>`: dismiss specific notification
+- `dismiss-all`: dismiss all notifications
+
+## environment variables
+- `CORVID_DEFAULT_EXPIRATION`: default notification expiration in ms. `-1` = never (default: `5000`)
+- `CORVID_SORT_DIRECTION`: notification sort direction, either `NEWEST_FIRST` or `OLDEST_FIRST` (default: `NEWEST_FIRST`)
-- 
cgit v1.2.3