diff --git a/README.rst b/README.rst index 3d7e823..21c399f 100644 --- a/README.rst +++ b/README.rst @@ -110,16 +110,13 @@ Contributors Contribute ---------- -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. +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. -The output attribute should be set to a dictionary which represents your modules output, +The ``output`` attribute should be set to a dictionary which represents your modules output, the protocol is documented `here `_. -To update this readme run ``python -m i3pystatus.mkdocs`` in the -repository root and you're done :) - Developer documentation is available in the source code and `here -`_. +`_. **Patches and pull requests are very welcome :-)**