From 6f2ca04898e2f5c853a734abe2cc3c1ce9da6e0a Mon Sep 17 00:00:00 2001 From: Benjamin Braatz Date: Fri, 5 Mar 2021 15:28:30 +0100 Subject: [PATCH] Switch README.md and description to English --- README.md | 20 +++++++++++--------- setup.py | 2 +- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5fffc50..6997a7e 100644 --- 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. diff --git a/setup.py b/setup.py index 500e1c7..63211d7 100644 --- 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", -- 2.34.1