summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@ifm.com>2022-03-17 18:11:01 +0100
committerMarcel Müller <m.mueller@ifm.com>2022-03-21 08:53:49 +0100
commit1eab40d959180b28e3f5df5a79b9e798c33c7b87 (patch)
tree5b52a21f953d097c97bc7bc4879825aa5fc0c145
parent8a8e1303a1a76676c5bca8fa77eaea4a5039c64e (diff)
Add description of crate
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
-rw-r--r--crates/core/tedge_api/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/crates/core/tedge_api/README.md b/crates/core/tedge_api/README.md
index f75b3855..d085a7e1 100644
--- a/crates/core/tedge_api/README.md
+++ b/crates/core/tedge_api/README.md
@@ -1 +1,9 @@
# Thin Edge API
+
+thin-edge is made up out of "Plugins"[^1] which pass messages to eachother.
+These plugins run on a "Core", which handles the message passing.
+This crate defines the interfaces a plugin author needs to implement so that a
+plugin can be built into thin-edge.
+
+[^1]: Name is subject to change.
+