aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
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`)