Skip to content

Commit 19dd81c

Browse files
authored
Clarify README.md: we are still an experiment.
1 parent fcdbac9 commit 19dd81c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[![Go Report Card](https://goreportcard.com/badge/github.com/multicluster-runtime/multicluster-runtime)](https://goreportcard.com/report/github.com/multicluster-runtime/multicluster-runtime)
22
[![godoc](https://pkg.go.dev/badge/github.com/multicluster-runtime/multicluster-runtime)](https://pkg.go.dev/github.com/multicluster-runtime/multicluster-runtime)
33

4+
> [!WARNING]
5+
> multicluster-runtime is currently an experiment to add multi-cluster support on-top of controller-runtime. It is not generally consumable yet. Use at your own risk. Contributions though are highly welcome.
6+
47
# multicluster-runtime
58

69
<img src="./contrib/logo/logo.png" width="300"/>
@@ -11,9 +14,6 @@
1114
- **universal**: kind, [cluster-api](https://github.com/kubernetes-sigs/cluster-api), [Gardener](https://gardener.cloud/) (tbd), kcp (WIP), BYO. Cluster providers make the controller-runtime multi-cluster aware.
1215
- **seamless**: add multi-cluster support without compromising on single-cluster. Run in either mode without code changes to the reconcilers.
1316

14-
> [!WARNING]
15-
> multicluster-runtime is currently alpha quality before its first stable and generally consumable release. Use at your own risk.
16-
1717
## Uniform Reconcilers
1818

1919
Run the same reconciler against many clusters:
@@ -32,7 +32,7 @@ Run reconcilers that listen to some cluster(s) and operate other clusters.
3232

3333
## Principles
3434

35-
1. multicluster-runtime is a friendly ❤️ extension of controller-runtime.
35+
1. multicluster-runtime is a friendly extension of controller-runtime.
3636
2. multicluster-runtime loves ❤️ contributions.
3737
3. multicluster-runtime is following controller-runtime releases.
3838
4. multicluster-runtime is developed as if it was part of controller-runtime (quality standards, naming, style).

0 commit comments

Comments
 (0)