Add more explanation to documentation.

diff --git a/doc/index.md b/doc/index.md
index 11baa12fa4bf24ab8eebb31178f9af86f71532db..2ffa3d3fcff7658f91a52bf70be62a552269a265 100644 (file)
--- a/doc/index.md
+++ b/doc/index.md
@@ -169,6 +169,16 @@ git-Repository enthalten:
 }
 ```
 
+Die Konfiguration einer `StateMachine`-Plugin-Instanz enthält ein Attribut
+`init`, das den initialen Zustand der Maschine benennt, und ein Attribut
+`states`, das ein Objekt enthält, dessen Schlüssel alle möglichen Zustände
+der Statemachine sind.
+Für jeden Zustand wird in `commands` eine Liste von Nachrichten angegeben,
+die beim Betreten des Zustands gesendet werden sollen, während in
+`transitions` eine Liste von Transitionen definiert wird, die jeweils ein
+Nachrichten-Schema als `trigger` und den Zustand, in den gewechselt werden
+soll, als `to` haben.
+
 In der Debug-Oberfläche sieht das Beispiel folgendermaßen aus:
 ![Debug-Oberfläche](graphit/controlpi-statemachine/DebugView.png)