From 3f3f7dd9bf2752e56f86ae30278d8999ce6d8e07 Mon Sep 17 00:00:00 2001
From: "R. Sharp" <8883519+tr0njavolta@users.noreply.github.com>
Date: Wed, 7 Feb 2024 14:06:00 -0500
Subject: [PATCH] Readme updates (#19)

* Update README.md

* description & README

* Update README.md

* Update README.md
---
 README.md       | 39 +++++++++++++++++++++++++++++++++++++--
 crossplane.yaml |  5 +++++
 2 files changed, 42 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3bc9f4a..d1ca8a2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
-# configuration-azure-network
+# Azure Network Configuration
 
-Azure Network 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 [Azure network]().
+
+## 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 [] API contains:
+
+- **an [Azure Network](/apis/definition.yaml) custom resource type.**
+- **Composition of the network resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions fundamental security and networking 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-azure-network
+spec:
+  package: xpkg.upbound.io/upbound/configuration-azure-network:v0.4.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.
diff --git a/crossplane.yaml b/crossplane.yaml
index ebfc228..5f4d65b 100644
--- a/crossplane.yaml
+++ b/crossplane.yaml
@@ -6,7 +6,12 @@ metadata:
     meta.crossplane.io/maintainer: Upbound <support@upbound.io>
     meta.crossplane.io/source: github.com/upbound/configuration-azure-network
     meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      This configuration provides a foundation to build and operate Azure networks.
+    meta.crossplane.io/readme: |
+     This configuration is used for deploying and managing Azure network clusters on Kubernetes using Crossplane. This setup provides the necessary infrastructure to deploy Azure network managed with Crossplane in Kubernetes. This approach ensures a flexible, streamlined deployment workflow.
 
+     For more details and customization options, you can explore [the GitHub repository](https://github.com/upbound/configuration-app).
 spec:
   crossplane:
     version: ">=v1.14.1-0"