README update
This commit is contained in:
parent
00079662df
commit
51253240b3
21
README.md
21
README.md
@ -6,12 +6,22 @@ Simple bar written in Rust
|
||||
|
||||
* A tool that returns variety of components in a string suitable to use in a
|
||||
status bar
|
||||
* Currently implemented modules:
|
||||
- weather
|
||||
- music
|
||||
- network
|
||||
- memory
|
||||
- cpu
|
||||
- power
|
||||
|
||||
# Usage
|
||||
|
||||
* Use the `--help` option for usage information:
|
||||
|
||||
```sh
|
||||
A tool that returns variety of components in a string
|
||||
suitable to use in a status bar
|
||||
|
||||
Usage: unibar [OPTIONS]
|
||||
|
||||
Options:
|
||||
@ -26,8 +36,11 @@ Options:
|
||||
-p, --music-progress
|
||||
Show music progess
|
||||
|
||||
-D, --debug-json
|
||||
Show JSON data returned by query
|
||||
-D, --debug
|
||||
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
|
||||
Print help (see a summary with '-h')
|
||||
@ -42,12 +55,12 @@ Options:
|
||||
|
||||
```shell
|
||||
$ 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
|
||||
|
||||
```shell
|
||||
$ 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
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user