diff --git a/README.rst b/README.rst index b6ed554..84b9d35 100644 --- a/README.rst +++ b/README.rst @@ -379,7 +379,7 @@ Settings: :alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``) :alert_format_body: The body text of the notification, all formatters can be used (default: ``Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!``) :path: Override the default-generated path (default: ``None``) -:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}``) +:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}``) :color: The text color (default: ``#ffffff``) :critical_color: The critical color (default: ``#ff0000``) :interval: (default: ``5``) @@ -666,7 +666,7 @@ Settings: :host: (default: ``localhost``) :port: MPD port (default: ``6600``) :format: formatp string (default: ``{title} {status}``) -:status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'play': '▶', 'pause': '▷'}``) +:status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'pause': '▷', 'play': '▶'}``) :interval: (default: ``1``) @@ -937,5 +937,8 @@ 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 :-)** diff --git a/README.tpl.rst b/README.tpl.rst index 9a723e1..44e7983 100644 --- a/README.tpl.rst +++ b/README.tpl.rst @@ -313,4 +313,7 @@ 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 :-)**