X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/d35e518e394b706cb791e30d4fcf7bd0498217ee..489c6f87d1d19831a7d43840dd76b111d657750b:/README

diff --git a/README b/README
index 77659b4..14544dc 100644
--- a/README
+++ b/README
@@ -9,13 +9,14 @@ Features
 - Battery percentage/power/state
 - CPU usage
 - CPU frequency
+- CPU iowait
 - Custom shell commands
 - Date and time
 - Disk status (free storage, percentage, total storage and used storage)
 - Available entropy
 - Username/GID/UID
 - Hostname
-- IP address
+- IP address (IPv4 and IPv6)
 - Kernel version
 - Keyboard indicators
 - Load average
@@ -30,8 +31,7 @@ Features
 
 Requirements
 ------------
-In order to build slstatus you need the Xlib header files and optionally ALSA
-for volume percentage. PulseAudio is not supported for various reasons.
+In order to build slstatus you need the Xlib header files.
 
 
 Installation
@@ -39,8 +39,8 @@ Installation
 Edit config.mk to match your local setup (slstatus is installed into the
 /usr/local namespace by default).
 
-Afterwards enter the following command to build and install dmenu (if necessary
-as root):
+Afterwards enter the following command to build and install slstatus (if
+necessary as root):
 
     make clean install
 
@@ -54,3 +54,15 @@ Configuration
 -------------
 slstatus can be customized by creating a custom config.h and (re)compiling the
 source code. This keeps it fast, secure and simple.
+
+
+Todo
+----
+Porting to OpenBSD is the current goal before thinking about a release.
+
+The following functions are not portable at the moment:
+- wifi_{perc,essid}
+- cpu_{freq,perc,iowait}
+- entropy
+- swap_{free,perc,total,used}
+- battery_{power,state}