This commit is contained in:
parent
1a631d94ff
commit
1579e3b48d
75
README.md
Normal file
75
README.md
Normal file
|
@ -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 `<name>` and run `<command>` when clicked.
|
||||
|
||||
```
|
||||
app <block_name> <name> <command> <background_color> <foreground_color>
|
||||
```
|
||||
|
||||
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 <block_name> <name> <mount_point> <limit_warning> <limit_danger>
|
||||
```
|
||||
|
||||
Show the IP of the given iface.
|
||||
|
||||
```
|
||||
ip <iface> <ip4|ip6> <name>
|
||||
```
|
||||
|
||||
Show the public IP.
|
||||
|
||||
```
|
||||
ip_wan
|
||||
```
|
||||
|
||||
Show the telemetry using Prusa Printer API.
|
||||
|
||||
```
|
||||
prusa_telemetry <block_name> http://<prusa_printer_ip>/api/telemetry
|
||||
```
|
||||
|
||||
Show indicator of RSS.
|
||||
|
||||
```
|
||||
rss <block_name> <feed_url> <feed_reader_url> <foreground_color_when_no_item> <foreground_color_when_items>
|
||||
```
|
||||
|
||||
Toggler for wireguard.
|
||||
|
||||
```
|
||||
wireguard <iface> <name>
|
||||
```
|
Loading…
Reference in a new issue