From 76d12a17aebb889f7433990267585bb8a283aee1 Mon Sep 17 00:00:00 2001 From: Jan Oliver Oelerich Date: Wed, 17 Oct 2012 08:29:31 +0200 Subject: [PATCH] extended readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 832398e..26fadfd 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,12 @@ Change your i3wm config to the following: And finally adjust the settings in `~/.config/i3status/contrib/wrapper.py` as you like. + +## Contribute + +To contribute a script, make sure it has a function `output()` that outputs +valid json code that can be interpreted by i3status. The protocol is documented +here: [i3status Protocol](http://i3wm.org/docs/i3bar-protocol.html). + +Please add an example for how to configure it to `wrapper.py`. It should be a +python class that can be registered with the `I3StatusHandler` class. \ No newline at end of file