From 671a6deebf9b0ad5362f98ed876c41052e3c7171 Mon Sep 17 00:00:00 2001 From: pete911 Date: Thu, 6 Jan 2022 15:54:54 +0000 Subject: [PATCH] update README with install instructions --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 34a7f9bd..908334c6 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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