Merge pull request #14 from tr0njavolta/patch-1

Readme updates

README.md

@@ -1,3 +1,39 @@
-# configuration-gcp-database
+# GCP database Configuration
 
-GCP Database 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 GCP database 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 GCP database API contains:
+
+- **an [GCP database](/apis/definition.yaml) custom resource type.**
+- **Composition of the GCP database resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an GCP databaseand 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-gcp-database
+spec:
+  package: xpkg.upbound.io/upbound/configuration-gcp-database:v0.1.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,12 @@ metadata:
     meta.crossplane.io/maintainer: Upbound <support@upbound.io>
     meta.crossplane.io/source: github.com/upbound/configuration-gcp-database
     meta.crossplane.io/license: Apache-2.0
+    meta.crossplane.io/description: |
+      This configuration provides a foundation to build and operate GCP database resources.
+    meta.crossplane.io/readme: |
+     This configuration is used for deploying and managing GCP database clusters using Crossplane. This setup provides the necessary infrastructure to deploy GCP database resources 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-gcp-database).
 
 spec:
   crossplane: