From fc6315be199305d21e4fb1b1a18917bec4147f3e Mon Sep 17 00:00:00 2001 From: xengineering Date: Sun, 24 May 2026 11:41:14 +0200 Subject: README.md: Add public API declaration This is required to properly use Semantic Versioning. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 219d2ef..01477f0 100644 --- a/README.md +++ b/README.md @@ -37,5 +37,16 @@ URL to access it is printed to the console. ./build/finserv-linux-amd64 ``` +## Public API declaration + +The following elements are declared as the public API of this project as +required by Semantic Versioning [3]: + +- command line arguments of the server executable +- HTTP API under the `/api` URL + +Everything else is not part of the public API. + [1]: https://git-scm.com/ [2]: https://mesonbuild.com/ +[3]: https://semver.org/spec/v2.0.0.html -- cgit v1.3