add num_files() function for maildirs ;)

[slstatus.git] / README.md

diff --git a/README.md b/README.md
index 23e6921..408477e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,8 +8,9 @@ Looking at the LOC (lines of code) of the [Conky project](https://github.com/brn
 
 The following information is included:
 
-- Battery percentage/state
+- Battery percentage/power/state
 - CPU usage (in percent)
+- CPU frequency (in MHz)
 - Custom shell commands
 - Date and time
 - Disk[s] status (free storage, percentage, total storage and used storage)
@@ -18,12 +19,14 @@ The following information is included:
 - Hostname
 - IP addresses
 - Kernel version
+- Keyboard indicators
 - Load averages
+- 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)
 - Temperature
 - Uptime
-- Volume percentage (ALSA)
+- Volume percentage (OSS/ALSA)
 - WiFi signal percentage and ESSID
 
 Multiple entries per function (e.g. multiple batteries) are supported and everything can be reordered and customized via a C header file (similar to other suckless programs).
@@ -50,6 +53,16 @@ If you use any other status bar or window manager you will have to figure it out
 
        slstatus -o | other_status_bar &
 
+### Specific function quirks
+
+- Volume percentage
+
+If there is no `/dev/mixer` on your system and you use ALSA, it means you have to load the OSS compatibility module by issuing:
+
+```
+# modprobe snd-pcm-oss
+```
+
 ## Contributing
 
 Hunt FIXME's in the code or do WTF you want! If it is useful, I will merge.