diff options
| author | xengineering <me@xengineering.eu> | 2025-12-20 15:33:19 +0100 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-12-20 15:33:19 +0100 |
| commit | 15a634093351f91b7bbaa68ccd9d0a2965eab6d1 (patch) | |
| tree | c91d17751edb5979cc0ce6f410b7a89e824eb109 | |
| parent | 9db4822c5b0991b0c19c3bb028110449a6ce8b82 (diff) | |
| download | sia-server-15a634093351f91b7bbaa68ccd9d0a2965eab6d1.tar sia-server-15a634093351f91b7bbaa68ccd9d0a2965eab6d1.tar.zst sia-server-15a634093351f91b7bbaa68ccd9d0a2965eab6d1.zip | |
README.md: Adhere to Semver / define public API
This project should use semantic versioning. This requires defining the
public Application Programming Interface (API).
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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/ |