README update

This commit is contained in:
Mahesh Asolkar 2025-06-07 16:29:03 -07:00
parent 00079662df
commit 51253240b3
Signed by: asolkar
GPG Key ID: 371CA8164433BDCC

View File

@ -6,12 +6,22 @@ Simple bar written in Rust
* A tool that returns variety of components in a string suitable to use in a * A tool that returns variety of components in a string suitable to use in a
status bar status bar
* Currently implemented modules:
- weather
- music
- network
- memory
- cpu
- power
# Usage # Usage
* Use the `--help` option for usage information: * Use the `--help` option for usage information:
```sh ```sh
A tool that returns variety of components in a string
suitable to use in a status bar
Usage: unibar [OPTIONS] Usage: unibar [OPTIONS]
Options: Options:
@ -26,8 +36,11 @@ Options:
-p, --music-progress -p, --music-progress
Show music progess Show music progess
-D, --debug-json -D, --debug
Show JSON data returned by query Show verbose debug information during run
-M, --debug-modules
Show module debug information after all modules are evaluated but before output is printed
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -42,12 +55,12 @@ Options:
```shell ```shell
$ target/release/unibar $ target/release/unibar
🌧️ 55.94°F 𝄞 Dire Straits - Tunnel of Love ⏸ Dire Straits - Tunnel of Love 💾 42% 💻 3% 🔌 99% 📶 192.168.1.93 ☀️ 83°F
``` ```
* With music progress * With music progress
```shell ```shell
$ target/release/unibar --music-progress $ target/release/unibar --music-progress
🌧️ 55.94°F 𝄞 Dire Straits - Tunnel of Love [ 22% 14:23] ⏸ Dire Straits - Tunnel of Love [2% 14:23] 💾 42% 💻 3% 🔌 99% 📶 192.168.1.93 ☀️ 83°F
``` ```