From: Benjamin Braatz <benjamin.braatz@graph-it.com>
Date: Wed, 9 Nov 2022 14:49:36 +0000 (+0100)
Subject: Add more explanation to documentation.
X-Git-Url: http://git.graph-it.com/?a=commitdiff_plain;h=d44615fe8b35ae6e10e634def3858bf9d4866fa0;p=graphit%2Fcontrolpi-statemachine.git

Add more explanation to documentation.
---

diff --git a/doc/index.md b/doc/index.md
index 11baa12..2ffa3d3 100644
--- 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)