From 15a634093351f91b7bbaa68ccd9d0a2965eab6d1 Mon Sep 17 00:00:00 2001 From: xengineering Date: Sat, 20 Dec 2025 15:33:19 +0100 Subject: README.md: Adhere to Semver / define public API This project should use semantic versioning. This requires defining the public Application Programming Interface (API). --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') 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/ -- cgit v1.2.3-70-g09d2