Add readme

2024-01-01 17:39:03 +01:00
parent 92af164f41
commit c5f633e9dd
1 changed files with 14 additions and 0 deletions
@@ -0,0 +1,14 @@
+# Multimessagebroker
+
+This software was created as part of my diploma thesis.
+It should make the Industry 4.0 accessible to brownfield machines.
+
+It works like a gateway by serving a I4.0 Interface (the Asset Administration Shell) and an arbitrary protocol to connect to the asset.
+
+- `lib` contains the main logic for the library.
+- `example` shows how to use the lib
+- `testasset` contains a simple script that pushes some values on MQTT
+- `owntest.json` contains the AASX description of the testasset
+
+`lib` must be build first, as it's currently not in npm and `example` uses it by path.
+Both can be build using `npm run build` and both have documentation that can be created using `npm run docs`.