Readme updates (#25)

* Update README.md

* description & README

* Update README.md

* Update README.md

* feat(crossplane): update crossplane.yaml

Signed-off-by: Christopher Haar <[email protected]>

---------

Signed-off-by: Christopher Haar <[email protected]>
Co-authored-by: Christopher Haar <[email protected]>

README.md

@@ -1,2 +1,39 @@
 # AWS Database Configuration
 
+
+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 [AWS database](https://aws.amazon.com/getting-started/decision-guides/databases-on-aws-how-to-choose/) instances.
+
+## 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 AWS database API contains:
+
+- **a [database](/apis/definition.yaml) custom resource type.**
+- **Composition of the database resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions AWS database 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-aws-database
+spec:
+  package: xpkg.upbound.io/upbound/configuration-aws-database:v0.8.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.

crossplane.yaml

@@ -6,6 +6,13 @@ metadata:
     meta.crossplane.io/maintainer: Upbound <[email protected]>
     meta.crossplane.io/source: github.com/upbound/configuration-aws-database
     meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      This repository provides a foundational configuration to build and operate an AWS database, including handling its dependencies and configurations. The setup ensures a streamlined and repeatable deployment in a cloud environment.
+
+    meta.crossplane.io/readme: |
+     This repository offers a specialized configuration for deploying and managing an AWS database on Kubernetes using Crossplane. This setup provides the necessary infrastructure to deploy RDS instances 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-aws-database).
 spec:
   crossplane:
     version: ">=v1.14.1-0"