Merge pull request #17 from upbound/readme-updates

Readme updates

README.md

@@ -1,4 +1,40 @@
-# GitOps Flux Configuration
+# Flux Configuration
 
-GitOps Flux Configuration is reusable Configuration designed to be primarily used in
-higher level Configurations.
+
+This repository contains a [Crossplane configuration](https://docs.crossplane.io/latest/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/latest/getting-started/introduction/) include:
+
+- **CompositeResourceDefinition (XRD):** Defines the API's structure.
+- **Composition(s):** Implements the API by orchestrating a set of Crossplane managed resources.
+
+In this specific configuration, the Flux API contains:
+
+- **a Flux (/apis/definition.yaml) custom resource type.**
+- **Composition of the Flux resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions Flux resources in the `upbound-system` namespace.
+
+
+This repository contains an Composite Resource (XR) file.
+
+## Deployment
+
+```shell
+apiVersion: pkg.crossplane.io/v1
+kind: Configuration
+metadata:
+  name: configuration-gitops-flux
+spec:
+  package: xpkg.upbound.io/upbound/configuration-gitops-flux:v0.2.0
+```
+
+## Next steps
+
+This repository serves as a foundational step. To enhance your control plane, consider:
+
+1. create new API definitions in this same repo
+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.