DOCS for local development

helm · Jun 28, 2024 · 1c8f141 · 1c8f141
1 parent a31e38a
commit 1c8f141
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -2,7 +2,7 @@ FROM alpine:3.18
 
 RUN apk --no-cache add ca-certificates git
 
-COPY cr /usr/local/bin/cr
+COPY cr-bin /usr/local/bin/cr
 
 # Ensure that the binary is available on path and is executable
 RUN cr --help

diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ $ git clone https://github.com/helm/chart-releaser
 $ cd chart-releaser
 $ go mod download
 $ go install ./...
+$ go build -o cr-bin ./cr/main.go
 ```
 
 ### Docker (for Continuous Integration)

diff --git a/doc/cr_index.md b/doc/cr_index.md
@@ -4,10 +4,8 @@ Update Helm repo index.yaml for the given GitHub repo
 
 ### Synopsis
 
-
 Update a Helm chart repository index.yaml file based on a the
 given GitHub repository's releases.
-
 
 ```
 cr index [flags]
@@ -41,5 +39,5 @@ cr index [flags]
 
 ### SEE ALSO
 
-* [cr](cr.md)	 - Helm Chart Repos on Github Pages
+* [cr](cr.md) - Helm Chart Repos on Github Pages