diff --git a/README.md b/README.md new file mode 100644 index 0000000..6155cd6 --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +# I3 Blocks + +Blocks compatible with [i3blocks](https://github.com/vivien/i3blocks). + +## Requirements + +* go for compilation +* `sudo` for `wireguard` block +* `tmux` for `app` and `date` blocks +* `df` for `du` block +* `xdg-open` for `du` block + +## Installation + +### From binaries + +Get binaries for [releases](https://gitnet.fr/deblan/i3-blocks-go/releases) + +### From sources + +``` +git clone https://gitnet.fr/deblan/i3-blocks-go.git +cd i3-blocks-go +make +``` + +## Usage + +Add the shortcut `` and run `` when clicked. + +``` +app +``` + +Show the time using given format and run `gnome-calendar` when clicked. + +``` +date "%H:%M:%S %d/%m/%Y" +``` + +Show mount point usage and warns with limits and colors. + +``` +du +``` + +Show the IP of the given iface. + +``` +ip +``` + +Show the public IP. + +``` +ip_wan +``` + +Show the telemetry using Prusa Printer API. + +``` +prusa_telemetry http:///api/telemetry +``` + +Show indicator of RSS. + +``` +rss +``` + +Toggler for wireguard. + +``` +wireguard +```