Add basic readme and changelog

jokey2k · Oct 9, 2022 · a68f92e · a68f92e
1 parent 11524e4
commit a68f92e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 1.0.0 (2022-10-09)
+## Initial release
+Comes without support for ETCS and ZBS messages
diff --git a/README.md b/README.md
@@ -1,2 +1,7 @@
 # pyzusi3
-Library to talk to Zusi3 without any specialized purpose
+Library to talk to Zusi3 without any specialized purpose.
+
+Support for ETCS and ZBS is not yet complete, however the other parts can be used freely.
+
+Intentionally the message parameters are taken almost word-by-word from Zusi documentation to make using the lib easier.
+So be prepared for some mixing of code language (english) and zusi-lib language (german).