README

README.md

@@ -1,43 +1,48 @@
+<!--
+    Always edit README.tpl.md and create README.md by running
+    python -m i3pystatus.mkdocs
+    You can also let the maintainer do the latter :)
+-->
+
 # i3pystatus
 
 i3pystatus is a (hopefully growing) collection of python scripts for 
 status output compatible to i3status / i3bar of the i3 window manager.
 
-## Version 3
-
-Version 3 has been merged into master recently, please check out if your config still works,
-as many modules have been reworked (mostly added options) and the new settings system is in-place.
-For examples how it works, take a look at the __main__.py.dist file with some examples.
-
 ## Installation
 
-To install it, follow these steps:
+### From PyPI package [i3pystatus](https://pypi.python.org/pypi/i3pystatus)
 
-    cd ~/.config/i3status/
+    pip install i3pystatus
-    git clone git@github.com:enkore/i3pystatus contrib
-    cd contrib/i3pystatus
-    cp __main__.py.dist __main__.py
 
-Add the following to `~/.config/i3status/config`:
+### Packages for your OS
 
-    general {
+    * [Arch Linux](https://aur.archlinux.org/packages/i3pystatus-git/)
-        output_format = "i3bar"
-        colors = true
-        interval = 5
-    }
 
-Change your i3wm config to the following:
+## Configuration
+
+You can keep your config file at various places, i3pystatus will look
+for it in these places:
+
+    ~/.i3pystatus.py
+    ~/.i3/i3pystatus.py
+    ~/.config/i3pystatus.py
+    $XDG_CONFIG_HOME/i3pystatus.py
+    /etc/i3pystatus.py
+    /etc/xdg/i3pystatus.py
+    $XDG_CONFIG_DIRS/i3pystatus.py
+
+A sample configuration file is `i3pystatus/__main__.py.dist`
+
+Also change your i3wm config to the following:
 
     # i3bar
     bar {
-        status_command    cd ~/.config/i3status/contrib ; i3status | python -m i3pystatus
+        status_command    i3pystatus
         position          top
         workspace_buttons yes
     }
 
-And finally adjust the settings in `~/.config/i3status/contrib/i3pystatus/__main__.py`
-as you like. 
-
 ## Modules
 
 Many modules let you modify the output via a
@@ -198,10 +203,10 @@ The `backends` setting determines the backends to use. Currently available are:
 > 
 > 
 > * `host` —  (required)
-> * `port` —  (default: `143`)
+> * `port` —  (default: `993`)
 > * `username` —  (required)
 > * `password` —  (required)
-> * `ssl` —  (default: `False`)
+> * `ssl` —  (default: `True`)
 > 
 > 
 > 
@@ -303,9 +308,11 @@ Simple regex file watcher
 ### runwatch
 
 
-Expands the given path using glob to a pidfile and checks if the process ID found inside is valid
+Expands the given path using glob to a pidfile and checks
+if the process ID found inside is valid
 (that is, if the process is running).
-You can use this to check if a specific application, such as a VPN client or your DHCP client is running.
+You can use this to check if a specific application, 
+such as a VPN client or your DHCP client is running.
 
 Available formatters are {pid} and {name}.
 
@@ -371,3 +378,4 @@ a python class that can be registered with the `I3statusHandler` class. Also don
 forget to add yourself to the LICENSE file.
 
 **Patches and pull requests are very welcome :-)**
+

README.tpl.md

@@ -1,43 +1,48 @@
+<!--
+    Always edit README.tpl.md and create README.md by running
+    python -m i3pystatus.mkdocs
+    You can also let the maintainer do the latter :)
+-->
+
 # i3pystatus
 
 i3pystatus is a (hopefully growing) collection of python scripts for 
 status output compatible to i3status / i3bar of the i3 window manager.
 
-## Version 3
-
-Version 3 has been merged into master recently, please check out if your config still works,
-as many modules have been reworked (mostly added options) and the new settings system is in-place.
-For examples how it works, take a look at the __main__.py.dist file with some examples.
-
 ## Installation
 
-To install it, follow these steps:
+### From PyPI package [i3pystatus](https://pypi.python.org/pypi/i3pystatus)
 
-    cd ~/.config/i3status/
+    pip install i3pystatus
-    git clone git@github.com:enkore/i3pystatus contrib
-    cd contrib/i3pystatus
-    cp __main__.py.dist __main__.py
 
-Add the following to `~/.config/i3status/config`:
+### Packages for your OS
 
-    general {
+    * [Arch Linux](https://aur.archlinux.org/packages/i3pystatus-git/)
-        output_format = "i3bar"
-        colors = true
-        interval = 5
-    }
 
-Change your i3wm config to the following:
+## Configuration
+
+You can keep your config file at various places, i3pystatus will look
+for it in these places:
+
+    ~/.i3pystatus.py
+    ~/.i3/i3pystatus.py
+    ~/.config/i3pystatus.py
+    $XDG_CONFIG_HOME/i3pystatus.py
+    /etc/i3pystatus.py
+    /etc/xdg/i3pystatus.py
+    $XDG_CONFIG_DIRS/i3pystatus.py
+
+A sample configuration file is `i3pystatus/__main__.py.dist`
+
+Also change your i3wm config to the following:
 
     # i3bar
     bar {
-        status_command    cd ~/.config/i3status/contrib ; i3status | python -m i3pystatus
+        status_command    i3pystatus
         position          top
         workspace_buttons yes
     }
 
-And finally adjust the settings in `~/.config/i3status/contrib/i3pystatus/__main__.py`
-as you like. 
-
 ## Modules
 
 Many modules let you modify the output via a

i3pystatus/mkdocs.py

@@ -11,7 +11,7 @@ import i3pystatus.mail
 
 from .core.imputil import ClassFinder
 
-IGNORE = ("__main__", "mkdocs")
+IGNORE = ("__main__", "mkdocs", "core")
 MODULE_FORMAT = """
 {heading} {name}
 

mkdocs.sh

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-python -m i3pystatus.mkdocs
-