From 64a407b689f5b8e94402e228f2efe0540934f01c Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Thu, 17 Dec 2020 18:09:25 -0500 Subject: [PATCH] Add gh-pages Readme Signed-off-by: Scott Rigby --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..23eefad0e3 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# kube-state-metrics 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/kubernetes/kube-state-metrics/workflows/Release%20Charts/badge.svg?branch=master) + +## 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 kube-state-metrics https://kubernetes.github.io/kube-state-metrics +``` + +You can then run `helm search repo kube-state-metrics` to see the charts. + +## Contributing + +The source code of the `kube-state-metrics` [Helm](https://helm.sh) chart can be found on Github: + + +We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/kubernetes/kube-state-metrics/blob/master/CONTRIBUTING.md) for details. + +## License + + +[Apache 2.0 License](https://github.com/kubernetes/kube-state-metrics/blob/master/LICENSE). + +## Helm charts build status + +![Release Charts](https://github.com/kubernetes/kube-state-metrics/workflows/Release%20Charts/badge.svg?branch=master)