masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
enkore 2014-08-15 17:01:10 +02:00
parent f50e6c1cf7
commit f502117ae3
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -9,6 +9,11 @@ i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager. status output compatible to i3status / i3bar of the i3 window manager.
- `Release Notes`_
- `Configuration`_
- `Modules`_
- `Contribute`_
Installation Installation
------------ ------------
@ -431,7 +436,7 @@ Settings:
:alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``) :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!``) :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``) :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``) :color: The text color (default: ``#ffffff``)
:full_color: The full color (default: ``#00ff00``) :full_color: The full color (default: ``#00ff00``)
:charging_color: The charging 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``) :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/``) :rightclick: URL to visit or command to run on right click (default: ``https://bitcoinaverage.com/``)
:interval: Update interval. (default: ``600``) :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 :-)** **Patches and pull requests are very welcome :-)**
Table of contents
-----------------
.. contents:: Overview of this rather long README

10
README.tpl.rst
View File

@ -9,6 +9,11 @@ i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager. status output compatible to i3status / i3bar of the i3 window manager.
- `Release Notes`_
- `Configuration`_
- `Modules`_
- `Contribute`_
Installation Installation
------------ ------------
@ -366,3 +371,8 @@ Developer documentation is available in the source code and `here
<http://i3pystatus.readthedocs.org/en/latest/>`_. <http://i3pystatus.readthedocs.org/en/latest/>`_.
**Patches and pull requests are very welcome :-)** **Patches and pull requests are very welcome :-)**
Table of contents
-----------------
.. contents:: Overview of this rather long README