Skip to content

Commit

Permalink
update README with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pete911 committed Jan 6, 2022
1 parent d6e8e99 commit 671a6de
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -3,7 +3,18 @@ Helm chart releaser is a tool to help to host helm repository as GitHub page, wh
a release asset and the index file is hosted on GitHub page. This tool is very similar to
[helm chart releaser](https://github.com/helm/chart-releaser), but is simpler and works with private repos as well.

## Download
- [binary](https://github.com/pete911/hcr/releases)

## Install

### Brew
```
add tap brew tap pete911/tap
install brew install hcr
```

### Go
```
git clone https://github.com/pete911/hcr.git
cd hcr
Expand Down Expand Up @@ -42,3 +53,6 @@ This makes it simpler and easier than [helm chart releaser](https://github.com/h
reading from GitHub pages (or downloading releases) over http, so we don't face issues with restrictions on private
repositories (autogenerated pages link, authentication, ...), caching (GitHub pages are not updated immediately with
the latest changes) etc.

## Release
Releases are published when the new tag is created e.g. git tag -m "add super cool feature" v0.0.1 && git push --follow-tags

0 comments on commit 671a6de

Please sign in to comment.