diff --git a/README.md b/README.md index 23d4ffc..8671a9b 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,13 @@ Settings ## 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). +To contribute a module, make sure it uses one of the Module classes. Most modules +use IntervalModule, which just calls a function repeatedly in a specified interval. -Please add an example for how to configure it to `wrapper.py.dist`. It should be -a python class that can be registered with the `I3StatusHandler` class. +The output attribute should be set to a dictionary which represents your modules output, +the protocol is documented [here](http://i3wm.org/docs/i3bar-protocol.html). +Please add an example for how to configure it to `__main__.py.dist`. It should be +a python class that can be registered with the `I3statusHandler` class. + +**Patches and pull requests are very welcome :-)**