From 8ca5c80c380cdd925d87b497fb23eddb6b58843f Mon Sep 17 00:00:00 2001 From: Gerald Venzl Date: Wed, 9 Sep 2026 12:24:42 -0700 Subject: [PATCH] Update README as v1.0.0 has been reached (#2233) Co-authored-by: Eric Ernst --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 153e0457..e6d0cfdc 100644 --- a/README.md +++ b/README.md @@ -99,4 +99,11 @@ Contributions to `container` are welcome and encouraged. Please see our [main co ## Project Status -The container project is currently under active development. Its stability, both for consuming the project as a Swift package and the `container` tool, is only guaranteed within patch versions, such as between 0.1.1 and 0.1.2. Minor version releases may include breaking changes until we reach a 1.0.0 release. +The container project is under active development. Its release versions are product versions, not semantic versions. + +The `container` CLI compatibility generally preserves backward compatibility within a major release (not breaking existing scripts), however, there may be the odd case where breaking compatibility may be necessary. **Note:** Features marked *experimental* (for example, the `k8s` subcommand) may change and do not guarantee backward compatibility. + +The `container-apiserver` XPC API compatibility preserves forward and backward compatibility within a major version. +Other non-public XPC helpers do not guarantee CLI or API compatibility across different versions. + +The `container` application data provides forward compatibility only, guaranteed within one major version. Upgrading to a newer major version may require a specific upgrade path.