diff --git a/README.md b/README.md index 44cf792..a0a08de 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,36 @@ Small app that perform system check and print TMUX friendly output. ![Preview](.github/prev.png) -### Features: -1. `tmux-helper -cb` print cpu load with bar. -2. `tmux-helper -mb` print memory usage with bar. -3. `tmux-helper -p` show current player status using d-bus. - ### Building `cargo build --release` or get binary on release page -### Customization -Colours are hardcoded but it's easy to change it. It defined as CONST in very beginning of main.rs file. +### Fetures +```shell +tmux-helper 0.3.2 +Ultra Desu +Utility for printing system info for tmux status line. + +USAGE: + tmux-helper [FLAGS] [OPTIONS] + +FLAGS: + -c, --cpu Print cpu load bar. + -h, --help Prints help information + -m, --mem Print mem usage bar. + -d, --mpd Show mpd player using MPD native protocol. + -p, --mpris Show player info using MPRIS2 interface. + -V, --version Prints version information + +OPTIONS: + --COLOR_END Default color using to terminate others. + --COLOR_HIGH CPU and MEM bar color while high usage. + --COLOR_LOW CPU and MEM bar color while low usage. + --COLOR_MID CPU and MEM bar color while mid usage. + --COLOR_TRACK_ARTIST Color of artist name filed. + --COLOR_TRACK_NAME Color of track name filed. + --COLOR_TRACK_TIME Color of playing time field. + -l, --localtime Local time + -a, --mpd-address : of MPD server. + -u, --utctime UTC time +```