summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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