summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3fd2e81..c9f153a 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,19 @@ The configuration file format can be looked up based on the
The files in the `systemd` folder are provided for integration into
[systemd][4]-based Linux distributions.
+## Versioning and public Application Programming Interface (API)
+
+This project adheres to [Semantic Versioning][5].
+
+Only aspects explicitly stated here are part of the public API:
+
+- file and folder structure of the deploy archive
+- `sia-server-linux-amd64` command line interface
+- configuration file format
+- MQTT interface
+
[1]: https://homematic-ip.com/
[2]: https://openccu.de/
[3]: https://homematic-ip.com/en/product/window-and-door-contact-optical
[4]: https://systemd.io/
+[5]: https://semver.org/