From e26557e2af5cff98aba8d49f0831c658472db15d Mon Sep 17 00:00:00 2001
From: Sharp <8883519+tr0njavolta@users.noreply.github.com>
Date: Sun, 4 Feb 2024 21:28:32 -0500
Subject: [PATCH] description & README

---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index bbfefdf..41262f4 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,20 @@
-# GitOps Flux Configuration
+# Flux Configuration
 
-This repository contains a [configuration](https://docs.crossplane.io/v1.11/concepts/packages/#configuration-packages), tailored for users establishing their initial control plane with [Upbound](https://cloud.upbound.io). This configuration deploys fully managed Flux instances, allowing you to integrate GitOps practices into your workflow.
+
+This repository contains a [Crossplane configuration](https://docs.crossplane.io/v1.11/concepts/packages/#configuration-packages), tailored for users establishing their initial control plane with [Upbound](https://cloud.upbound.io). This configuration deploys fully managed Flux instances allowing you to integrate GitOps practices into your workflow.
 
 ## Overview
 
 The core components of a custom API in [Crossplane](https://docs.crossplane.io/v1.11/getting-started/introduction/) include:
 
 - **CompositeResourceDefinition (XRD):** Defines the API's structure.
-- **Composition(s):** Implements the API by orchestrating a set of managed resources.
+- **Composition(s):** Implements the API by orchestrating a set of Crossplane managed resources.
+
+In this specific configuration, the Flux API contains:
 
-In this specific configuration, the [Flux] API contains:
+- **an Flux (/apis/definition.yaml) custom resource type.**
+- **Composition of the Flux resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an Flux resources in the `upbound-system` namespace.
 
-- **an [](/apis/definition.yaml) custom resource type.**
-- **Composition of the [] resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an [] cluster and fundamental security and networking resources in the `upbound-system` namespace.
 
 This repository contains an Composite Resource (XR) file.
 
@@ -22,9 +24,9 @@ This repository contains an Composite Resource (XR) file.
 apiVersion: pkg.crossplane.io/v1
 kind: Configuration
 metadata:
-  name: configuration-gitops-flux
+  name: PACKAGE NAME
 spec:
-  package: xpkg.upbound.io/upbound/configuration-gitops-flux:v0.2.0
+  package: PACKAGE SPEC
 ```
 
 ## Next steps
@@ -35,4 +37,4 @@ This repository serves as a foundational step. To enhance your control plane, co
 2. editing the existing API definition to your needs
 
 
-Upbound will automatically detect the commits you make in your repo and build the configuration package for you. To learn more about how to build APIs for your managed control planes in Upbound, read the guide on Upbound's docs.
+Upbound will automatically detect the commits you make in your repo and build the configuration package for you. To learn more about how to build APIs for your managed control planes in Upbound, read the guide on Upbound's docs.
\ No newline at end of file