diff --git a/README.md b/README.md index e6695ea..fd72b2c 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ # cluster-api-provider-metal + +[![REUSE status](https://api.reuse.software/badge/github.com/ironcore-dev/cluster-api-provider-metal)](https://api.reuse.software/info/github.com/ironcore-dev/cluster-api-provider-metal) +[![Go Report Card](https://goreportcard.com/badge/github.com/ironcore-dev/cluster-api-provider-metal)](https://goreportcard.com/report/github.com/ironcore-dev/cluster-api-provider-metal) +[![GitHub License](https://img.shields.io/static/v1?label=License&message=Apache-2.0&color=blue)](LICENSE) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com) + +The `cluster-api-provider-metal` is an infrastructure provider for [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api), an open-source project that simplifies lifecycle management of Kubernetes clusters. +This provider allows ClusterAPI to manage clusters using the MetalAPI developed as part of the IronCore Project. + +## Installation, Usage, and Development + +For more details please refer to documentation folder [/docs](https://github.com/ironcore-dev/cluster-api-provider-metal/tree/main/docs) + +## Feedback and Support + +Feedback and contributions are always welcome! + +Please report bugs, suggestions or post questions by opening a [Github issue](https://github.com/ironcore-dev/cluster-api-provider-metal/issues). + +## License + +Copyright 2024. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file