From 75201b189f256b1c995a2415f604d88e3cbf1114 Mon Sep 17 00:00:00 2001 From: Paul Wilde Date: Tue, 3 May 2022 21:48:16 +0100 Subject: [PATCH] updated readme with brief descriptions of each tool --- README.MD | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.MD b/README.MD index e62035a..0cacace 100644 --- a/README.MD +++ b/README.MD @@ -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