summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
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