From 6eec360873ca10c8e462c87ad50c38d1a4332638 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Moritz=20Schmitz=20von=20H=C3=BClst?=
 <m.schmitzvonhuelst@gmail.com>
Date: Tue, 27 Jul 2021 09:45:20 +0200
Subject: [PATCH] Remove reference to github api, add documentation for
 chart-releaser cli (#77)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* remove reference to github api, add documentation for chart-releaser cli

Signed-off-by: Moritz Schmitz von Hülst <moritz@hauptstadtoffice.com>
---
 README.md | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 316890f..febe426 100644
--- a/README.md
+++ b/README.md
@@ -13,13 +13,17 @@ A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, usi
 
 ### Inputs
 
-For more information on inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)
-
 - `version`: The chart-releaser version to use (default: v1.2.1)
-- `config`: Optional config file for chart-releaser
+- `config`: Optional config file for chart-releaser. For more information on the config file, see the [documentation](https://github.com/helm/chart-releaser#config-file)
 - `charts_dir`: The charts directory
 - `charts_repo_url`: The GitHub Pages URL to the charts repo (default: `https://<owner>.github.io/<project>`)
 
+### Environment variables
+
+- `CR_TOKEN` (required): The GitHub token of this repository (`${{ secrets.GITHUB_TOKEN }}`)
+
+For more information on environment variables, see the [documentation](https://github.com/helm/chart-releaser#environment-variables).
+
 ### Example Workflow
 
 Create a workflow (eg: `.github/workflows/release.yml`):
@@ -60,6 +64,28 @@ jobs:
 This uses [@helm/chart-releaser-action](https://www.github.com/helm/chart-releaser-action) to turn your GitHub project into a self-hosted Helm chart repo.
 It does this – during every push to `main` – by checking each chart in your project, and whenever there's a new chart version, creates a corresponding [GitHub release](https://help.github.com/en/github/administering-a-repository/about-releases) named for the chart version, adds Helm chart artifacts to the release, and creates or updates an `index.yaml` file with metadata about those releases, which is then hosted on GitHub Pages
 
+#### Example using custom config
+
+`workflow.yml`:
+```yaml
+- name: Run chart-releaser
+  uses: helm/chart-releaser-action@v1.2.0
+  with:
+    charts_dir: charts
+    config: cr.yaml
+    charts_repo_url: xxxxxx
+  env:
+    CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+```
+
+`cr.yaml`:
+```yaml
+owner: myaccount
+git-base-url: https://api.github.com/
+```
+
+For options see [config-file](https://github.com/helm/chart-releaser#config-file). 
+
 ## Code of conduct
 
 Participation in the Helm community is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).