From a420204e5d9f64f5a295be1cbbb6b3e2c4394e09 Mon Sep 17 00:00:00 2001 From: Alexandr Bogomyakov Date: Wed, 16 Jul 2025 16:20:41 +0300 Subject: [PATCH] Update README.md --- README.md | 68 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 44 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 80682ce..34fe378 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Tmux helper Small app that perform system check and print TMUX friendly output. -![Preview](.github/prev.png) +image + ### Building `cargo build --release` @@ -9,31 +10,50 @@ or get binary on release page ### Fetures ```shell -tmux-helper 0.3.2 -Ultra Desu Utility for printing system info for tmux status line. -USAGE: - tmux-helper [FLAGS] [OPTIONS] +Usage: tmux-helper [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 +Options: + -c, --cpu + Print cpu load bar. + -m, --mem + Print mem usage bar. + --low + Low threshold (0.0 - 1.0) [default: 0.7] + --mid + Mid threshold (0.0 - 1.0) [default: 0.9] + -p, --mpris + Show player info using MPRIS2 interface. + -d, --mpd + Show mpd player using MPD native protocol. + -l, --localtime [] + Local time + -u, --utctime [] + UTC time + -s, --symbol [] + Symbol to build bar [default: ▮] + -e, --empty-symbol [] + Symbol to represent the empty part of the bar [default: ▯] + -a, --mpd-address + : of MPD server. [default: 127.0.0.1:6600] + --COLOR_LOW + CPU and MEM bar color while low usage. [default: 119] + --COLOR_MID + CPU and MEM bar color while mid usage. [default: 220] + --COLOR_HIGH + CPU and MEM bar color while high usage. [default: 197] + --COLOR_TRACK_NAME + Color of track name filed. [default: 46] + --COLOR_TRACK_ARTIST + Color of artist name filed. [default: 46] + --COLOR_TRACK_TIME + Color of playing time field. [default: 153] + --COLOR_END + Default color using to terminate others. [default: 153] + -h, --help + Print help + -V, --version + Print version ```