From cbf63ab822518d07ee400c2ea7fcf66ffac99584 Mon Sep 17 00:00:00 2001 From: Candifloss Date: Sat, 21 Sep 2024 19:35:44 +0000 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cdd7a8f..0bdcf57 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ -# SNot +# SNot: Simple NOTification -Simple NOTification \ No newline at end of file +A simple [desktop notification](https://wiki.archlinux.org/title/Desktop_notifications) server/daemon using the [`dbus`](https://dbus.freedesktop.org/doc/dbus-tutorial.html) protocol. SNot listens for notifications on the [`org.freedesktop.Notifications`](https://specifications.freedesktop.org/notification-spec/latest/basic-design.html) interface, and prints them to the console. +Inspired by [`tiramisu`](https://github.com/Sweets/tiramisu) + +## Features +- Prints desktop notifications to the console(or a file, if you redirect it) as text +- Do one thing and do it well([DOTADIW](https://en.wikipedia.org/w/index.php?title=Unix_philosophy&useskin=vector#Do_One_Thing_and_Do_It_Well)) & [KISS](https://en.wikipedia.org/wiki/KISS_Principle) principle: no extra complicated features +- (Not really a feature) Written in [`rust`](https://www.rust-lang.org/) using the [`zbus`](https://docs.rs/zbus/latest/zbus/) crate + +## Upcoming feature + +- Better ways to work with other programs + +## Currently supported formats + +- Plain text - Print the output text. (✓ Just print it) +- [`json`](https://json.org) - This output can be parsed by other programs + +## Upcoming format(s) + +- [`rson`](https://github.com/rson-rs/rson) - A more sensible alternative to json