docs: first README version

README.md

@@ -1,2 +1,21 @@
-# cluster-api-addon-provider-kubewarden
-CAAPKW manages the deployment of Kubewarden policies in downstream clusters
+# CAPI Addon Provider Kubewarden - CAAPKW
+
+<a href="https://cluster-api.sigs.k8s.io"><img alt="capi" src="./logos/kubernetes-cluster-logos_final-02.svg" width="160x" /></a>
+<p>
+<a href="https://github.com/caapkw/cluster-api-addon-provider-kubewarden"><img src="https://godoc.org/sigs.k8s.io/cluster-api?status.svg"></a>
+</p>
+
+# Cluster API Add-on Provider for Kubewarden
+
+### 👋 Welcome to CAAPKW! Here are some links to help you get started:
+
+- [Quick start guide](./docs/quick-start.md)
+- [Development guide](./docs/development.md)
+
+## ✨ What is Cluster API Add-on Provider for Kubewarden?
+
+Cluster API Add-on Provider for Kubewarden extends Cluster API by managing the installation and configuration of [Kubewarden](https://docs.kubewarden.io/) in CAPI clusters. Kubewarden (a CNCF Sandbox project) is a Kubernetes Policy Engine that aims to be the universal Policy Engine for Kubernetes.
+
+Given a `KubewardenAddon` specification, CAAPKW manages the installation of the policy engine to CAPI workload clusters simplifying security compliance for your CAPI-provisioned clusters.
+
+This project is a concrete implementation of a `ClusterAddonProvider`, a pluggable component to be deployed on the Management Cluster. You can read the proposal document for `ClusterAddonProvider` [here](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20220712-cluster-api-addon-orchestration.md).

docs/development.md

@@ -0,0 +1 @@
+## Development

docs/quick-start.md

@@ -0,0 +1 @@
+## Getting started

logos/LICENSE.md

@@ -0,0 +1,13 @@
+All artwork in this repo is made available under the Linux Foundation trademark
+usage [guidelines](https://www.linuxfoundation.org/trademark-usage/).
+
+This text from those guidelines, and the correct and incorrect usage examples, are
+particularly helpful:
+
+> Certain marks of The Linux Foundation have been created to enable you to
+> communicate compatibility or interoperability of software or products.
+> In addition to the requirement that any use of a mark to make an assertion
+> of compatibility must, of course, be accurate, the use of these marks must
+> avoid confusion regarding The Linux Foundation’s association with the product.
+> The use of the mark cannot imply that The Linux Foundation or its projects are
+> sponsoring or endorsing the product.

logos/README.md

@@ -0,0 +1,15 @@
+# Cluster API related logos and artwork
+
+## Cluster API - It's Kubernetes all the way down
+
+![Cluster API - It's Kubernetes all the way down](kubernetes-cluster-logos_final-02.svg)
+
+[Pantone color reference](kubernetes-cluster-logos_2.pdf)
+
+## Cluster API - Clusters as Cattle
+
+![Cluster API - Clusters as Cattle](kubernetes-cluster-logos_final-01.svg)
+
+[Pantone color reference](kubernetes-cluster-logos_1.pdf)
+
+Use of any trademark or logo is subject to the trademark policy available at https://www.linuxfoundation.org/trademark-usage

logos/icons/README.md

@@ -0,0 +1,10 @@
+# Cluster API Icons Set
+
+These icons are a way to standardize Cluster API architecture diagrams, building on top of the [Kubernetes Icon Set](https://git.k8s.io/community/icons). Having uniform architecture diagrams improve understandibility.
+
+## License
+The Kubernetes Icons Set is licensed under a choice of either Apache-2.0
+or CC-BY-4.0 (Creative Commons Attribution 4.0 International). The
+Kubernetes logo is a registered trademark of The Linux Foundation, and use
+of it as a trademark is subject to The Linux Foundation's Trademark Usage
+Guidelines at https://www.linuxfoundation.org/trademark-usage/.