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

diff --git a/README b/README
index 77659b4..c278599 100644
--- a/README
+++ b/README
@@ -6,7 +6,7 @@ slstatus is a suckless status monitor for window managers that use WM_NAME
 
 Features
 --------
-- Battery percentage/power/state
+- Battery percentage/state/time left
 - CPU usage
 - CPU frequency
 - Custom shell commands
@@ -15,10 +15,11 @@ Features
 - Available entropy
 - Username/GID/UID
 - Hostname
-- IP address
+- IP address (IPv4 and IPv6)
 - Kernel version
 - Keyboard indicators
 - Load average
+- Network speeds (RX and TX)
 - Number of files in a directory (hint: Maildir)
 - Memory status (free memory, percentage, total memory and used memory)
 - Swap status (free swap, percentage, total swap and used swap)
@@ -30,17 +31,16 @@ 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
 ------------
 Edit config.mk to match your local setup (slstatus is installed into the
-/usr/local namespace by default).
+/usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.
 
-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,8 @@ 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
+----
+Cleaning up the whole codebase it the goal before thinking about a release.