Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gh-pages Readme #1335

Merged
merged 1 commit into from
Jan 13, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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: <https://github.com/kubernetes/kube-state-metrics/tree/master/charts/kube-state-metrics>

<!-- Keep full URL links to repo files because this README syncs from main to gh-pages. -->
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

<!-- Keep full URL links to repo files because this README syncs from main to gh-pages. -->
[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)