Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sabineschaller committed Jun 6, 2023
1 parent 0127d31 commit 5e385bc
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
# Interledger Kubernetes 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/interledger/helm-charts/workflows/Release%20Charts/badge.svg?branch=main)

This functionality is in alpha and is subject to change. The code is provided as-is with no warranties.

## 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 interledger https://interledger.github.io/helm-charts
```

You can then run `helm search repo interledger` to see the charts.

## Contributing

The source code of all [Interledger](https://interledger.org) community [Helm](https://helm.sh) charts can be found on Github: <https://github.com/interledger/helm-charts/>

<!-- 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/interledger/helm-charts/blob/main/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/interledger/helm-charts/blob/main/LICENSE).

## Helm charts build status

![Release Charts](https://github.com/interledger/helm-charts/workflows/Release%20Charts/badge.svg?branch=main)

0 comments on commit 5e385bc

Please sign in to comment.