From d258142f57f612389d01d49ae27b96379e3ae0ad Mon Sep 17 00:00:00 2001
From: stefanprodan <stefan.prodan@gmail.com>
Date: Thu, 28 May 2020 10:03:36 +0300
Subject: [PATCH] Add usage docs

---
 README.md  | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 action.yml |  8 ++++----
 2 files changed, 62 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 9b82aa8..d9cb042 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,59 @@
 # helm-gh-pages
-A GitHub Action for publish Helm charts to Github Pages
+
+A GitHub Action for publishing Helm charts with Github Pages.
+
+## Usage
+
+Inputs:
+* `token` The GitHub token with write access to the target repository
+* `charts_dir` The charts directory, defaults to `charts`
+* `charts_url` The GitHub Pages URL, defaults to `https://<OWNER>.github.io/<REPOSITORY>`
+* `owner` The GitHub user or org that owns this repository, defaults to the owner in `GITHUB_REPOSITORY` env var
+* `repository` The GitHub repository, defaults to the `GITHUB_REPOSITORY` env var
+* `branch` The branch to publish charts, defaults to `gh-pages`
+* `helm_version` The Helm CLI version, defaults to the latest release
+
+## Examples
+
+Package and push all charts in `./charts` dir to `gh-pages` branch:
+
+```yaml
+name: release
+on:
+  push:
+    tags: '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Publish Helm charts
+        uses: stefanprodan/helm-gh-pages@master
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Package and push charts in `./chart` dir to `gh-pages` branch in a different repository:
+
+```yaml
+name: release-chart
+on:
+  push:
+    tags: 'chart.*'
+
+jobs:
+  release-chart:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Publish Helm chart
+        uses: stefanprodan/helm-gh-pages@master
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          charts_dir: chart
+          charts_url: https://charts.fluxcd.io
+          owner: fluxcd
+          repository: charts
+          branch: gh-pages
+```
diff --git a/action.yml b/action.yml
index 99713cd..55f9642 100644
--- a/action.yml
+++ b/action.yml
@@ -1,4 +1,4 @@
-name: 'helm-gh-pages'
+name: 'Helm Publisher'
 description: 'A GitHub Action for publishing Helm charts with Github Pages'
 author: 'Stefan Prodan'
 branding:
@@ -12,13 +12,13 @@ inputs:
     description: "The charts directory, defaults to `charts`"
     required: false
   charts_url:
-    description: "The GitHub Pages URL, defaults to `https://<USER>.github.io/<REPOSITORY>`"
+    description: "The GitHub Pages URL, defaults to `https://<OWNER>.github.io/<REPOSITORY>`"
     required: false
   owner:
-    description: "The GitHub user or org that owns this repository, defaults to GITHUB_REPOSITORY"
+    description: "The GitHub user or org that owns this repository, defaults to `GITHUB_REPOSITORY`"
     required: false
   repository:
-    description: "The GitHub repository name, defaults to GITHUB_REPOSITORY"
+    description: "The GitHub repository name, defaults to `GITHUB_REPOSITORY`"
     required: false
   branch:
     description: "The branch to publish charts, defaults to `gh-pages`"