Readme
This commit is contained in:
parent
5474980b11
commit
2625de19dc
13
README.md
13
README.md
@ -57,10 +57,13 @@ Settings
|
|||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
To contribute a script, make sure it has a function `output()` that outputs
|
To contribute a module, make sure it uses one of the Module classes. Most modules
|
||||||
valid json code that can be interpreted by i3status. The protocol is documented
|
use IntervalModule, which just calls a function repeatedly in a specified interval.
|
||||||
here: [i3status Protocol](http://i3wm.org/docs/i3bar-protocol.html).
|
|
||||||
|
|
||||||
Please add an example for how to configure it to `wrapper.py.dist`. It should be
|
The output attribute should be set to a dictionary which represents your modules output,
|
||||||
a python class that can be registered with the `I3StatusHandler` class.
|
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 :-)**
|
||||||
|
Loading…
Reference in New Issue
Block a user