diff options
| author | xengineering <me@xengineering.eu> | 2024-05-01 11:36:09 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2024-05-01 11:36:09 +0200 |
| commit | ab6d2d7e2560761c9a369e623ddfbe0202188934 (patch) | |
| tree | 142c2d523ffba29f2a6428d7a0f82d19d4b5ee1d | |
| parent | 7cbe33ae59757d67a6b31030aef0769f86acf3c2 (diff) | |
| download | ceres-ab6d2d7e2560761c9a369e623ddfbe0202188934.tar ceres-ab6d2d7e2560761c9a369e623ddfbe0202188934.tar.zst ceres-ab6d2d7e2560761c9a369e623ddfbe0202188934.zip | |
Define public API in README.md
This is required according to semver.org.
| -rw-r--r-- | README.md | 14 |
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 |