diff --git a/README.md b/README.md index 6837abb..43a2eef 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Blocks compatible with [i3blocks](https://github.com/vivien/i3blocks). ## Requirements * `go` for compilation -* `sudo` for `wireguard` block +* `sudo` and `wg-quick` for `wireguard` block * `tmux` for `app` and `date` blocks * `df` for `du` block * `xdg-open` for `du` block @@ -27,81 +27,112 @@ make ## Usage +Each binary has a help, eg `./app -h`. + +### App + Add the shortcut `` and run `` when clicked. ``` -app -block= -name= -cmd= -bg-color= -fg-color +command=/path/to/app -block= -name= -cmd= -bg-color= -fg-color ``` +### Date + Show the time using given format and run `gnome-calendar` when clicked. ``` -date -format="%H:%M:%S %d/%m/%Y" +command=/path/to/date -format="%H:%M:%S %d/%m/%Y" ``` +### Disk usage + Show mount point usage and warns with limits and colors. ``` -du -block= -name= -mount-point= -limit-warning= -limit-danger= +command=/path/to/du -block= -name= -mount-point= -limit-warning= -limit-danger= ``` +### IP + Show the IP of the given iface. ``` -ip -iface= -version= -name= +command=/path/to/ip -iface= -version= -name= ``` +### IP (wan) + Show the public IP. ``` -ip_wan +command=/path/to/ip_wan ``` +### Prusa telemetry + Show the telemetry using Prusa Printer API. ``` -prusa_telemetry -api=http://1.2.3.4/api/telemetry +command=/path/to/prusa_telemetry -api=http://1.2.3.4/api/telemetry ``` +### Process + Show a message when the given process is running (use `preg -f`). ``` -ps -process= -message= +command=/path/to/ps -process= -message= ``` +### Feed indicator + Show indicator of RSS. ``` -rss -block= -feed= -website= -empty-color= -non-empty-color= +command=/path/to/rss -block= -feed= -website= -empty-color= -non-empty-color= ``` +### Spotify status + Show current song played (spotify). ``` -spotify +command=/path/to/spotify ``` +### Volume + Show volume. ``` -volume -channel= +command=/path/to/volume -channel= ``` +### Wireguard toggler + Toggler for wireguard. ``` -wireguard -iface= -name= +command=/path/to/wireguard -iface= -name= ``` -Add a blocks that represent opened apps to create a task bar. +### Task bar + +Add blocks that represent opened apps and create a task bar. ``` -workspace_apps 0 $BLOCK_BUTTON -workspace_apps 1 $BLOCK_BUTTON -workspace_apps 2 $BLOCK_BUTTON -workspace_apps 3 $BLOCK_BUTTON -workspace_apps 4 $BLOCK_BUTTON -workspace_apps 5 $BLOCK_BUTTON -workspace_apps 6 $BLOCK_BUTTON -workspace_apps 7 $BLOCK_BUTTON +[workspace_apps_0] +command=/path/to/workspace_apps 0 $BLOCK_BUTTON +format=json +markup=pango +interval=1 + +[workspace_apps_1] +command=/path/to/workspace_apps 1 $BLOCK_BUTTON +format=json +markup=pango +interval=1 + +... ```