From ab6d2d7e2560761c9a369e623ddfbe0202188934 Mon Sep 17 00:00:00 2001 From: xengineering Date: Wed, 1 May 2024 11:36:09 +0200 Subject: Define public API in README.md This is required according to semver.org. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..69d6c8b --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Ceres - Recipe server for local networks + +## API definition for Semantic Versioning + +Ceres uses Semantic Versioning as defined by [semver.org][1]. This requires to +define a "public API". These aspects of Ceres together form the public API: + +- command line interface +- HTTP interface +- data storage format + +As soon as version 1.0.0 is reached these aspects are stable. + +[1]: https://semver.org -- cgit v1.2.3-70-g09d2