updated readme with brief descriptions of each tool

This commit is contained in:
Paul Wilde 2022-05-03 21:48:16 +01:00
parent 912d413748
commit 75201b189f

View file

@ -27,6 +27,18 @@ or
```
it can also be run without any arguments to receive a i3bar compatible json string
## Tools
- `pingclock` performs a single `ping` to a server and returns the response time
- `battery` shows the current battery level
- `brightness` shows the current backlight level and gives options to adjust it
- `volume` shows the current volume level and gives options to adjust and manage it
- `date` shows the date
- `fuzzytime` shows the fuzzytime clock
- `wlan` shows the state of the wireless network interface. SSID connected to and signal level.
- `nic` shows the status and/or the ip address of the network interface card
- `temperature` shows the current CPU temperature
- `notes` a simple one liner note taking tool, displaying notes in dmenu/rofi
Personally, I have these bound to key combinations in i3. In fact, I have a seperate `bindsym` mode in which all these tools are accessible i.e. `$mod+i` to get to "info" mode then `p` to show pingclock.
## You can also set the volume and brightness levels by typing a numeric figure into the dmenu/rofi input box