use the enum module to represent states
[~helmut/onoff.git] / README.md
index 30d6d33..cd41bc6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,12 +33,10 @@ Use cases
 Dependencies
 ============
 
- * python version 2.6 or 2.7. In 3.x `GObject.spawn_async` is
-   [broken](http://bugs.debian.org/712537).
- * python-dbus
- * python-gi
- * python-argparse if your python version is less than 2.7
- * python-mpd if you intend to use `mpd_watcher.py`
+ * At least Python version 3.5 (e.g. Debian stretch).
+ * python3-dbus
+ * python3-gi
+ * python3-mpd if you intend to use `mpd_watcher.py`
  * sispmctl if you intend to control a power socket with this tool
 
 API
@@ -60,9 +58,12 @@ There currently are four implementations.
 
  *  An `OnoffProcess` can be used if the device is considered active as long as
     the process runs. Deactivation is achieved by killing the process. For
-    example the [redshift][] can be started in this way.
+    example [redshift][] can be started in this way.
 
-        dev = onoff.processs.OnoffProcess(["redshift"], 3)
+        dev = onoff.processs.OnoffProcess(["redshift"])
+
+    To account for the time it takes the process to start up, it can be wrapped
+    in a `ThrottledDevice` (see below).
 
  *  An `InvertedDevice` can be used to swap the activation states. It can be
     used to activate a device all the time and inhibit activation whenever the