X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/47a0e8dec3f146bc14934bb2e2516fa3b6fdc926..bc12a40dec3ddf8914df035349ea771d79ed56db:/README.md

diff --git a/README.md b/README.md
index 8bd2a91..2c25f0e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
 # slstatus
+
 A suckless status monitor for DWM written in pure C without any system() calls.
+
+# Information included
+
+- wifi percentage
+- battery percentage
+- cpu usage in percent
+- cpu temperature
+- ram usage in percent
+- alsa volume level in percent
+- disk usage
+- date
+- time
+
+Multiple batteries, wifi cards etc. are supported and everything can be reordered and customized via a C header file (similar to DWM).
+
+# Screenshot
+
+![screenshot](screenshot.png)
+
+# Installation
+
+Just run ```sudo make install```! :P
+
+# Configuration
+
+Just change config.h (commented) to your needs and recompile!
+
+# Starting
+
+Put the following code in your ~/.xinitrc:
+
+```
+while true; do
+    slstatus
+done &
+```
+
+# Contributing
+
+See TODO.md for things that you could do.
+
+People who contributed are listed in the CONTRIBUTORS.md file.
+
+If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces.