From 76ccc989b290b81b252a50926e52000d5500d6cc Mon Sep 17 00:00:00 2001
From: Chance Zibolski <chance.zibolski@gmail.com>
Date: Sun, 8 Sep 2024 14:51:28 -0700
Subject: [PATCH] examples: Add README to argocd-cm-plugin example

Signed-off-by: Chance Zibolski <chance.zibolski@gmail.com>
---
 examples/argocd-cm-plugin/README.md | 33 +++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 examples/argocd-cm-plugin/README.md

diff --git a/examples/argocd-cm-plugin/README.md b/examples/argocd-cm-plugin/README.md
new file mode 100644
index 0000000..e8cd0ca
--- /dev/null
+++ b/examples/argocd-cm-plugin/README.md
@@ -0,0 +1,33 @@
+# Argo CD Config Management Plugin Example
+
+This example will deploy Argo CD with `yamlforge` configured as a custom Config Management Plugin (CMP).
+
+You will also use `yamlforge` to manage the configuration of Argo CD, and deploy an example `Application` that uses the `yamlforge` CMP.
+
+## Setup
+
+Create a Kubernetes cluster using [KIND](https://kind.sigs.k8s.io):
+
+```
+kind create cluster
+```
+
+## Deploy
+
+Next, use `yamlforge` to render the Argo CD helm chart, and the example `Application`:
+
+```
+yfg generate examples/argocd-cm-plugin/forge.yaml | kubectl apply -f -
+```
+
+Within a few minutes, you should see an `nginx` pod in the default namespace:
+
+```
+kubectl get pods -n default
+```
+
+## Review
+
+The [`forge.yaml`](./forge.yaml) used the `helm` generator to deploy ArgoCD and the `value` generator to configure an `Application` to deploy.
+
+The example application can be found in the [`example-app`](./example-app) directory.