diff --git a/README.md b/README.md new file mode 100755 index 0000000..2434f92 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Flux2 Community Helm Charts + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Release Charts](https://github.com/fluxcd-community/helm-charts/workflows/Release%20Charts/badge.svg?branch=main) + +These helm charts are maintained and released by the fluxcd-community on a best effort basis. + +## Usage + +[Helm](https://helm.sh) must be installed to use the charts. +Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. + +Once Helm is set up properly, add the repo as follows: + +```console +helm repo add fluxcd-community https://fluxcd-community.github.io/helm-charts +``` + +You can then run `helm search repo fluxcd-community` to see the charts + +## Contributing + +The source code of all [Flux2](https://fluxcd.io) community [Helm](https://helm.sh) charts can be found on Github: + + +We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/fluxcd-community/helm-charts/blob/main/CONTRIBUTING.md) for details. + + +## License + +[Apache 2.0 License](https://github.com/fluxcd-community/helm-charts/blob/main/LICENSE). + +## Helm charts build status + +![Release Charts](https://github.com/fluxcd-community/helm-charts/workflows/Release%20Charts/badge.svg?branch=main) \ No newline at end of file