From 16cc7724757b5682a2cb11d36d7bc35ecf6d299c Mon Sep 17 00:00:00 2001 From: candifloss Date: Sun, 22 Sep 2024 15:57:03 +0530 Subject: [PATCH] edited README --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5c837ca..6899526 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,24 @@ Inspired by [`tiramisu`](https://github.com/Sweets/tiramisu) - 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 +## 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 -## Why? +## Upcoming feature + +- Better handling of `json` and `rson` data +- Better ways to work with other programs + +## Usage + +```bash +snot [r|j|p] [v] +``` + +## Why this project? - Something simple to work with [`EWW`](https://github.com/elkowar/eww) widgets - I'm learning Rust \ No newline at end of file