From f9b452cee235babc2786b86e51319d0e8bfd8b61 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86gir=20M=C3=A1ni=20Hauksson?=
<54936225+sourcehawk@users.noreply.github.com>
Date: Thu, 2 Apr 2026 01:39:50 +0100
Subject: [PATCH 1/5] add note about the framework's intentions
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index a75b3c08..11305b70 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,10 @@ status reporting, and lifecycle behavior into reusable building blocks (**compon
your controllers stay thin and focused on construction and orchestration, without sacrificing customizability where it
matters.
+> **Note:** This is not a replacement for [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) or
+> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use on top of them to
+> manage the layers between the reconciler and the Kubernetes resources it manages.
+
From bfb14b0dd400c2ed05431337ba6926268dc0d7dc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86gir=20M=C3=A1ni=20Hauksson?=
<54936225+sourcehawk@users.noreply.github.com>
Date: Thu, 2 Apr 2026 01:41:19 +0100
Subject: [PATCH 2/5] test
---
README.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 11305b70..f8d13718 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,15 @@ status reporting, and lifecycle behavior into reusable building blocks (**compon
your controllers stay thin and focused on construction and orchestration, without sacrificing customizability where it
matters.
-> **Note:** This is not a replacement for [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) or
-> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use on top of them to
-> manage the layers between the reconciler and the Kubernetes resources it manages.
-
+> ![NOTE]
+> This is not a replacement for [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) or
+> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use on top of them to
+> manage the layers between the reconciler and the Kubernetes resources it manages.
+
---
## Mental Model
From edec1c1509bc40fe1506520bb643f596105ea12b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86gir=20M=C3=A1ni=20Hauksson?=
<54936225+sourcehawk@users.noreply.github.com>
Date: Thu, 2 Apr 2026 01:46:02 +0100
Subject: [PATCH 3/5] update note
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index f8d13718..94b808f6 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,9 @@ matters.
-> ![NOTE]
-> This is not a replacement for [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) or
-> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use on top of them to
+> [!NOTE]
+> This framework is not a replacement for [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
+> It is a library you use inside controller-runtime reconcilers, such as in Kubebuilder-generated projects, to
> manage the layers between the reconciler and the Kubernetes resources it manages.
---
From a9b468a1d0cb91b97541d51533bc4179c71d05cc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86gir=20M=C3=A1ni=20Hauksson?=
<54936225+sourcehawk@users.noreply.github.com>
Date: Thu, 2 Apr 2026 01:46:29 +0100
Subject: [PATCH 4/5] format
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 94b808f6..d74372fe 100644
--- a/README.md
+++ b/README.md
@@ -13,10 +13,10 @@ matters.
-> [!NOTE]
-> This framework is not a replacement for [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
-> It is a library you use inside controller-runtime reconcilers, such as in Kubebuilder-generated projects, to
-> manage the layers between the reconciler and the Kubernetes resources it manages.
+> [!NOTE] This framework is not a replacement for
+> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use inside
+> controller-runtime reconcilers, such as in Kubebuilder-generated projects, to manage the layers between the reconciler
+> and the Kubernetes resources it manages.
---
From 640a9b741a9abd5d2ec58c899b5201c6db87e6a6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=86gir=20M=C3=A1ni=20Hauksson?=
<54936225+sourcehawk@users.noreply.github.com>
Date: Thu, 2 Apr 2026 01:47:45 +0100
Subject: [PATCH 5/5] prevent formatter from collapsing the note
---
README.md | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index d74372fe..f8a6cd5b 100644
--- a/README.md
+++ b/README.md
@@ -13,10 +13,11 @@ matters.
-> [!NOTE] This framework is not a replacement for
-> [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime). It is a library you use inside
-> controller-runtime reconcilers, such as in Kubebuilder-generated projects, to manage the layers between the reconciler
-> and the Kubernetes resources it manages.
+> [!NOTE]
+>
+> This framework is not a replacement for [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
+> It is a library you use inside controller-runtime reconcilers, such as in Kubebuilder-generated projects, to manage
+> the layers between the reconciler and the Kubernetes resources it manages.
---