Merge pull request #57 from embik/extend-readme

Extend README.md and align other documents

Author: kcp-ci-bot

CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+This project is following the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). For a current version of the Code of Conduct, please see [here](https://github.com/kcp-dev/kcp/blob/main/code-of-conduct.md).

CONTRIBUTING.md

@@ -4,9 +4,9 @@ We're thrilled that you're interested in contributing to kcp! Please visit our
 [full contributing guide](https://docs.kcp.io/kcp/main/en/CONTRIBUTING/) on our documentation site.
 
 Beside that, what coverns the project and all contributions to it must follow
-the [KCP Project Governance](./GOVERNANCE.md).
+the [kcp Project Governance](https://github.com/kcp-dev/kcp/blob/main/GOVERNANCE.md).
 
-From the KCP Project Governance, the following manifesto should guide the technical
+From the kcp Project Governance, the following manifesto should guide the technical
 decisions through-out all contributions:
 
 > kcp maintainers strive to be good citizens in the Kubernetes project.

README.md

@@ -1,16 +1,63 @@
 # kcp-dev/kcp-operator
 
-This is a work-in-progress operator to deploy and manage kcp instances. Please check back later!
+[![Go Report Card](https://goreportcard.com/badge/github.com/kcp-dev/kcp-operator)](https://goreportcard.com/report/github.com/kcp-dev/kcp-operator)
+[![GitHub](https://img.shields.io/github/license/kcp-dev/kcp-operator)](https://img.shields.io/github/license/kcp-dev/kcp-operator)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kcp-dev/kcp-operator?sort=semver)](https://img.shields.io/github/v/release/kcp-dev/kcp-operator?sort=semver)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkcp-dev%2Fkcp-operator.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcp-dev%2Fkcp-operator?ref=badge_shield)
 
-## Requirements
+> [!WARNING]
+> While kcp-operator is usable, the project is still in an early state. Please only use it if you know what you are doing. We recommend against using it in production setups right now.
+
+kcp-operator is a Kubernetes operator to deploy and run [kcp](https://github.com/kcp-dev/kcp) instances on a Kubernetes cluster. kcp is a horizontally scalable control plane for Kubernetes-like APIs.
+
+## Features
+
+- [x] Create and update core components of a kcp setup (root shard, additional shards, front proxy)
+- [x] Support for multi-shard deployments of kcp
+- [ ] Support for a dedicated cache-server deployment not embedded in the root shard
+- [x] Generate and refresh kubeconfigs for accessing kcp instances or specific shards
+- [ ] Cross-namespace/-cluster setups of a multi-shard kcp deployment
+
+## Support Matrix
+
+The table below marks known support of a kcp version in kcp-operator versions.
+
+| kcp    | `main`             |
+| ------ | ------------------ |
+| `main` | :warning: [^1]     |
+| 0.27.x | :white_check_mark: |
+
+[^1]: While we try to support kcp's `main` branch, this support is best effort and should not be used for deploying actual kcp instances.
+
+## Installation
+
+### Requirements
 
 - [cert-manager](https://cert-manager.io/)
 
+
+### Helm Chart
+
+A Helm chart for kcp-operator is maintained in [kcp-dev/helm-charts](https://github.com/kcp-dev/helm-charts/tree/main/charts/kcp-operator). To install it, first add the Helm repository:
+
+```sh
+helm repo add kcp https://kcp-dev.github.io/helm-charts
+```
+
+And then install the chart:
+
+```sh
+helm upgrade --install --create-namespace --namespace kcp-operator kcp/kcp-operator kcp-operator
+```
+
 ## Quickstart
 
 ### RootShard
 
-Running a root shard requires a running etcd instance/cluster. You can set up a simple one via Helm (THIS IS INSECURE, NEVER DEPLOY ETCD LIKE THIS IN PRODUCTION):
+> [!CAUTION]
+> Never deploy etcd like below in production as it sets up an etcd instance without authentication or TLS.
+
+Running a root shard requires a running etcd instance/cluster. You can set up a simple one via Helm:
 
 ```sh
 $ helm install etcd oci://registry-1.docker.io/bitnamicharts/etcd --set auth.rbac.enabled=false --set auth.rbac.create=false
@@ -73,6 +120,15 @@ graph TB
     classDef cert color:orange
 ```
 
+## Contributing
+
+Thanks for taking the time to start contributing!
+
+### Before You Start
+
+* Please familiarize yourself with the [Code of Conduct][4] before contributing.
+* See [our contributor documentation][2] for instructions on the developer certificate of origin that we require.
+
 ### Running E2E tests locally
 
 In order to run the E2E tests locally, you will need to setup cert-manager with the sample clusterissuer:
@@ -81,3 +137,20 @@ In order to run the E2E tests locally, you will need to setup cert-manager with
 helm upgrade --install --namespace cert-manager --create-namespace --version v1.16.2 --set crds.enabled=true cert-manager jetstack/cert-manager
 kubectl apply -n cert-manager --filename hack/ci/testdata/clusterissuer.yaml
 ```
+
+### Pull Requests
+
+* We welcome pull requests. Feel free to dig through the [issues][1] and jump in.
+
+## Changelog
+
+See [the list of releases][3] to find out about feature changes.
+
+## License
+
+This project is licensed under [Apache-2.0](./LICENSE).
+
+[1]: https://github.com/kcp-dev/kcp-operator/issues
+[2]: https://docs.kcp.io/kcp/main/contributing/getting-started/#developer-certificate-of-origin-dco
+[3]: https://github.com/kcp-dev/kcp-operator/releases
+[4]: https://github.com/kcp-dev/kcp/blob/main/code-of-conduct.md