From 1a04bc5a898b3a5717a3ebab38958725303df38d Mon Sep 17 00:00:00 2001
From: Junwei Zhao <wahyd4@gmail.com>
Date: Tue, 5 May 2020 08:45:46 +1000
Subject: [PATCH] Update readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index cd7acac..200bb43 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,39 @@
 # kubectl-helm-action
 A Github action for using kubectl and helm to deploy applications to Kubernetes cluster
 
+## How to use
+
+### Set up `KUBE_CONFIG_DATA` secret
+
+Have your `kubeconfig` file encrypted
+
+```bash
+cat $HOME/.kube/config | base64
+```
+Store the encrypted string as a secret with name `KUBE_CONFIG_DATA`, by navigating to your repo -> Settings -> Secrets -> Add a new secret
+
+### Config a Github workflow
+
+Create a workflow file `.github/workflows/deploy.yaml`
+
+```yaml
+on: push
+name: deploy
+jobs:
+  deploy:
+    name: deploy to cluster
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: deploy to cluster
+      uses: wahyd4/kubectl-helm-action@master
+      env:
+        KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
+      with:
+        args: kubectl apply -f manifest.yaml
+```
+
+
+## Thanks
+
+This repo is inspired by [steebchen/kubectl](https://github.com/steebchen/kubectl), thanks.