execute scripts instead of hardcoded

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
index eb26d3e..2d1a1d1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
 # status
 
 This is a status script for dwm
+
+## Modules
+
+Each module of your statusbar is a scripts that is located under `~/.local/share/status/`
+
+Each script will be executed in alphanumeric order, so if you want to have
+a specific order in which your bar is displayed use numbers as prefix
+of your scripts like this:
+
+```
+~/.local/share/status:
+    00_battery
+    01_volume
+    02_clock
+    ...
+```
+
+## Usage
+
+To start the status daemon use the `-d` flag.
+If you want that the statusbar updates a *unit*, for example *01_volume* when
+the volume buttons are pressed, just just execute `status -u 01_volume` to
+update the unit.
+
+## Config
+
+In the config under `~/.config/status/config` you can set the following
+variables:
+
+- CMDFIFO: Where to place the FIFO which is the communication layer between
+           the daemon and the update requests. (default: ~/.cache/status)
+- BINDIR: Where your unit files are stored (default: ~/.local/share/status/)
+- AUTOREFRESH: After how many seconds the statusbar should autorefresh (default: 60)
+
+The config is just sourced into the script so just use *POSIX-Shell* Syntax in it.