Xinqi Bao's Git

Formatting commit :(
[slstatus.git] / README.md
index 51db398..555a6b8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,12 +5,13 @@ slstatus
 
 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.
+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:
 
 - battery percentage
 - cpu usage (in percent)
+- custom shell commands
 - date and time
 - disk numbers (free storage, percentage, total storage and used storage)
 - available entropy
@@ -19,7 +20,7 @@ The following information is included:
 - ram numbers (free ram, percentage, total ram and used ram)
 - temperature
 - volume percentage (alsa)
-- wifi percentage
+- wifi percentage and essid
 
 Multiple entries per function are supported and everything can be reordered and customized via the C header file config.h (similar to DWM).
 
@@ -37,7 +38,7 @@ Put the following code in your ~/.xinitrc (or similar):
 
 ```
 while true; do
-    slstatus
+       slstatus
 done &
 ```