X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/27b9139dfc02b76801a5a33c6eef199c822d187a..9078fb351dc3d1e2eac261ec185acef1f66180bc:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index a604e86..404977f 100644
--- a/README.md
+++ b/README.md
@@ -3,19 +3,26 @@ slstatus
 
 **slstatus** is a suckless and lightweight status monitor for window managers which use WM_NAME as statusbar (e.g. DWM). It is written in pure C without any system() calls and only reads from files most of the time. It is meant as a better alternative to Bash scripts (inefficient) and Conky (bloated for this use).
 
+If you write a bash script that shows system information in WM_NAME, it executes a huge amount of external command (top, free etc.) every few seconds. This results in high system resource usage. slstatus solves this problem by only using C libraries and/or reading from files in sysfs / procfs.
+
+Looking at the LOC (lines of code) in the [Conky project](https://github.com/brndnmtthws/conky) is very interesting: *28.346 lines C++, 219 lines Python and 110 lines Lua*. slstatus currently has about **500 lines of clean, well commented C code** and even includes additional possibilities as it can be customized and extended very easily. Configuring it by editing config.h (a C header file) is very secure and fast as no config files are parsed at runtime.
+
 The following information is included:
 
-- wifi percentage
 - battery percentage
-- cpu usage in percent
-- cpu temperature
-- ram usage in percent
-- alsa volume level in percent
-- disk usage
-- date
-- time
+- cpu usage (in percent)
+- custom shell commands
+- date and time
+- disk numbers (free storage, percentage, total storage and used storage)
+- available entropy
+- hostname
+- ip addresses
+- ram numbers (free ram, percentage, total ram and used ram)
+- temperature
+- volume percentage (alsa)
+- wifi percentage
 
-Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).
+Multiple entries per function are supported and everything can be reordered and customized via the C header file config.h (similar to DWM).
 
 ![screenshot](screenshot.png)
 
@@ -23,7 +30,7 @@ Multiple entries (battery, wifi signal, ...) are supported and everything can be
 
 ### Installation
 
-Before you continue, please be sure that a C compiler, `make` and `alsa-lib` are installed. Then compile the program once using `sudo make install`. After that you may change config.h to your needs and recompile it after any change! 
+Before you continue, please be sure that a C compiler, GNU make and `alsa-lib` (for volume percentage) are installed. Then copy config.def.h to config.h and edit it to your needs. Recompile and install it after every change via `sudo make install`! 
 
 ### Starting
 
@@ -47,4 +54,4 @@ For detailed information about coding style and restrictions see [CONTRIBUTING.m
 
 ## License
 
-See [LICENSE.md](LICENSE.md).
+See [LICENSE](LICENSE).