From: Benjamin Braatz <bb@bbraatz.eu>
Date: Fri, 5 Mar 2021 14:43:43 +0000 (+0100)
Subject: Switch README.md and description to English
X-Git-Tag: v0.3.0~42
X-Git-Url: http://git.graph-it.com/?a=commitdiff_plain;h=cfae8d0b50ea2f3fbcd8b401f0ee78fe7c658319;p=graphit%2Fcontrolpi-wsserver.git

Switch README.md and description to English
---

diff --git a/README.md b/README.md
index 03a21de..493f5f5 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
-# ControlPi-Plugin für Websocket-Server
-Dieses Paket enthält ein Plugin für das ControlPi-System, mit dem ein
-Websocket-Server zur Verfügung gestellt wird, der eine Verbindung mit dem
-System durch verschiedene Clients ermöglicht. Außerdem stellt er eine
-einfache Debug-Oberfläche zur Verfügung, die alle auf dem System
-vorhandenen Komponenten, ihren momentanen Zustand und die zuletzt von ihnen
-gesandten Nachrichten darstellt und es ermöglicht, ihre Kommandos direkt
-aufzurufen.
+# ControlPi Plugin for Websocket Servers
+This distribution package contains a plugin for the
+[ControlPi system](https://docs.graph-it.com/graphit/controlpi), that
+provides a Websocket server connected to the message bus of the ControlPi.
+Clients connecting a Websocket to the server receive JSON serialisations of
+all messages on the bus and can also send to it.
+A minimal debug Web app is also included, which is served through the
+Websocket server and connects back to it to show all clients of the bus
+with their interfaces, last messages sent, and current state and allow to
+send messages to it.
 
-Die Dokumentation kann unter [doc/index.md](doc/index.md) bzw.
-[https://docs.graph-it.com/graphit/controlpi-wsserver](https://docs.graph-it.com/graphit/controlpi-wsserver)
-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-wsserver](https://docs.graph-it.com/graphit/controlpi-wsserver).
+Code documentation (in English) including doctests is contained in the
+source files.
diff --git a/setup.py b/setup.py
index 6570a5c..a62d71e 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 Websocket-Server",
+    description="ControlPi Plugin for Websocket Servers",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="http://docs.graph-it.com/graphit/controlpi-wsserver",