X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/83eae75dcf4659b55382873655081916e4bf100f..c7f3a407f4f8d539fe68cbf7dde76876cbcbccaa:/README.md

diff --git a/README.md b/README.md
index 620fc31..7f52167 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
-# slstatus
+slstatus
+========
 
-A suckless status monitor for DWM written in pure C without any system() calls.
+**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).
 
-# Information
+The following information is included:
 
 - wifi percentage
 - battery percentage
@@ -10,24 +11,23 @@ A suckless status monitor for DWM written in pure C without any system() calls.
 - cpu temperature
 - ram usage in percent
 - alsa volume level in percent
+- disk usage
 - date
 - time
 
-# Screenshot
+Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).
 
 ![screenshot](screenshot.png)
 
-# Installation
+## Usage
 
-Just run ```sudo make install```!
+### Installation
 
-# Configuration
+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! 
 
-Just edit config.h and recompile!
+### Starting
 
-# Starting
-
-Put this in your ~/.xinitrc:
+Put the following code in your ~/.xinitrc (or similar):
 
 ```
 while true; do
@@ -35,8 +35,16 @@ while true; do
 done &
 ```
 
-# Contributing
+The loop is needed that the program runs after suspend to ram.
+
+## Contributing
+
+In [TODO.md](TODO.md) there is a list of things that have to be done.
+
+People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md).
+
+For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md)
 
-People who contributed are listed in the CONTRIBUTORS.md file.
+## License
 
-If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)!
+See [LICENSE](LICENSE).