use the enum module to represent states
[~helmut/onoff.git] / README.md
index fc2911e..cd41bc6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -30,6 +30,15 @@ Use cases
    services. This is another inhibiting strategy. It is already being solved by
    [systemd-inhibit][] though.
 
+Dependencies
+============
+
+ * 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
 ===
 
@@ -49,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"])
 
-        dev = onoff.processs.OnoffProcess(["redshift"], 3)
+    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