Skip to content

Commit

Permalink
clean up README & add badges (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
elenz97 authored May 13, 2020
1 parent 542fcec commit 25dbd2c
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

Go client library for accessing [Helm](https://github.com/helm/helm), enabling the user to programmatically change helm charts and releases.

This library is build upon `helm/v3.1.2` and available under the MIT License:
This library is build upon `helm/v3.1.2` and available under the MIT License.

![Compile & Test](https://github.com/mittwald/go-helm-client/workflows/Compile%20&%20Test/badge.svg)
[![GitHub license](https://img.shields.io/github/license/mittwald/go-helm-client.svg)](https://github.com/mittwald/go-helm-client/blob/master/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/mittwald/go-helm-client)](https://goreportcard.com/report/github.com/mittwald/go-helm-client)
[![Documentation](https://godoc.org/github.com/mittwald/go-helm-client?status.svg)](https://pkg.go.dev/github.com/mittwald/go-helm-client)

## Usage
## Installation

```go
import "github.com/mittwald/go-helm-client"
```
Install this library using `go get`:

$ go get github.com/mittwald/go-helm-client

## Usage
Construct a new Helm client, then use the various services on the client to manage helm chart repositories and releases:
```go
package main
Expand Down Expand Up @@ -88,4 +93,4 @@ err := helmClient.AddOrUpdateChartRepo(repo.Entry{
```

## Documentation
For more specific documentation, please refer to the [godoc](https://pkg.go.dev/github.com/mittwald/go-helm-client/) of this library
For more specific documentation, please refer to the [godoc](https://pkg.go.dev/github.com/mittwald/go-helm-client/) of this library.

0 comments on commit 25dbd2c

Please sign in to comment.