From f502117ae3f9d0cb77c412de3c216407dfa1ee2f Mon Sep 17 00:00:00 2001 From: enkore Date: Fri, 15 Aug 2014 17:01:10 +0200 Subject: [PATCH] update readme --- README.rst | 14 ++++++++++++-- README.tpl.rst | 10 ++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 94690a1..741ceeb 100644 --- a/README.rst +++ b/README.rst @@ -9,6 +9,11 @@ i3pystatus i3pystatus is a (hopefully growing) collection of python scripts for status output compatible to i3status / i3bar of the i3 window manager. +- `Release Notes`_ +- `Configuration`_ +- `Modules`_ +- `Contribute`_ + Installation ------------ @@ -431,7 +436,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: ``{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}``) +:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}``) :color: The text color (default: ``#ffffff``) :full_color: The full color (default: ``#00ff00``) :charging_color: The charging color (default: ``#00ff00``) @@ -479,7 +484,7 @@ Settings: :leftclick: URL to visit or command to run on left click (default: ``electrum``) :rightclick: URL to visit or command to run on right click (default: ``https://bitcoinaverage.com/``) :interval: Update interval. (default: ``600``) -:status: (default: ``{'price_down': '▼', 'price_up': '▲'}``) +:status: (default: ``{'price_up': '▲', 'price_down': '▼'}``) @@ -1219,3 +1224,8 @@ Developer documentation is available in the source code and `here **Patches and pull requests are very welcome :-)** +Table of contents +----------------- + +.. contents:: Overview of this rather long README + diff --git a/README.tpl.rst b/README.tpl.rst index 14cc4f0..55d6e35 100644 --- a/README.tpl.rst +++ b/README.tpl.rst @@ -9,6 +9,11 @@ i3pystatus i3pystatus is a (hopefully growing) collection of python scripts for status output compatible to i3status / i3bar of the i3 window manager. +- `Release Notes`_ +- `Configuration`_ +- `Modules`_ +- `Contribute`_ + Installation ------------ @@ -366,3 +371,8 @@ Developer documentation is available in the source code and `here `_. **Patches and pull requests are very welcome :-)** + +Table of contents +----------------- + +.. contents:: Overview of this rather long README