edit README

This commit is contained in:
Candifloss 2024-09-26 16:27:48 +05:30
parent e83a14dac4
commit 5bcddfbad9

View File

@ -8,17 +8,6 @@ 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 - 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 - (Not really a feature) Written in [`rust`](https://www.rust-lang.org/) using the [`zbus`](https://docs.rs/zbus/latest/zbus/) crate
## Supported formats
- Plain text - Print the output text. (✓ Just print it)
- [`json`](https://json.org) - This output can be parsed by other programs
- [`rson`](https://github.com/rson-rs/rson) - A more sensible alternative to json
## Upcoming feature
- Better handling of `json` and `rson` data
- Better ways to work with other programs
## Usage ## Usage
```bash ```bash
@ -33,6 +22,17 @@ Options:
--help display usage information --help display usage information
``` ```
## Supported formats
- Plain text - Print the output text. (✓ Just print it)
- [`json`](https://json.org) - This output can be parsed by other programs
- [`rson`](https://github.com/rson-rs/rson) - A more sensible alternative to json
## Upcoming feature
- Better handling of `json` and `rson` data
- Better ways to work with other programs
## Why this project? ## Why this project?
- Something simple to work with [`EWW`](https://github.com/elkowar/eww) widgets - Something simple to work with [`EWW`](https://github.com/elkowar/eww) widgets