Switch README.md and description to English
authorBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 14:28:30 +0000 (15:28 +0100)
committerBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 14:35:12 +0000 (15:35 +0100)
README.md
setup.py

index 5fffc50647272951de8ada4fb7b19718bedb0413..6997a7ef83239c79e36477d479dbc24c3802fad2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
-# ControlPi-Plugin für Statemachines
-Dieses Paket enthält ein Plugin für das ControlPi-System, mit dem
-Statemachines konfiguriert werden können, die auf Nachrichten des zentralen
-Nachrichten-Busses des ControlPi-Systems reagieren und bei
-Zustands-Wechseln Kommandos/Nachrichten an andere Komponenten des Systems
-schicken.
+# ControlPi Plugin for Statemachines
+This distribution package contains a plugin for the
+[ControlPi system](https://docs.graph-it.com/graphit/controlpi), that
+allows to configure statemachines that react to messages on the central
+message bus of the ControlPi and send messages/commands to other components
+when switching states.
 
-Die Dokumentation kann unter [doc/index.md](doc/index.md) bzw.
-[https://docs.graph-it.com/graphit/controlpi-plugin](https://docs.graph-it.com/graphit/controlpi-plugin)
-gefunden werden.
+Documentation (in German) can be found at [doc/index.md](doc/index.md) in
+the source repository and at
+[https://docs.graph-it.com/graphit/controlpi-statemachine](https://docs.graph-it.com/graphit/controlpi-statemachine).
+Code documentation (in English) including doctests is contained in the
+source files.
index 500e1c769c9e974b731aa479f17da798dbd5e43e..63211d71abf3525c8aca4f209c0218f5089d3b2d 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -8,7 +8,7 @@ setuptools.setup(
     version="0.1.0",
     author="Graph-IT GmbH",
     author_email="info@graph-it.com",
-    description="ControlPi-Plugin für Statemachines",
+    description="ControlPi Plugin for Statemachines",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="http://docs.graph-it.com/graphit/controlpi-statemachine",