candifloss/SNot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

edited README

Browse Source
This commit is contained in:
Candifloss 2024-09-22 15:57:03 +05:30
parent 6fe5d22745
commit 16cc772475
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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 - 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
## Upcoming feature ## Supported formats
- Better ways to work with other programs
## Currently supported formats
- Plain text - Print the output text. (✓ Just print it) - Plain text - Print the output text. (✓ Just print it)
- [`json`](https://json.org) - This output can be parsed by other programs - [`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 - [`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 - Something simple to work with [`EWW`](https://github.com/elkowar/eww) widgets
- I'm learning Rust - I'm learning Rust