From 9ed4f16c0f5cc2c19b221504b1e9d3fb41a55d46 Mon Sep 17 00:00:00 2001
From: Aarnav Tale <aarnav@tale.me>
Date: Thu, 7 Apr 2022 10:04:29 -0400
Subject: [PATCH] feat: add readme

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1de4742
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# kubectl-action
+GitHub Action to manage a K8s (Kubernetes) cluster using kubectl.
+
+# Usage
+To use this action, add the following step to your GitHub Action workflow:
+```yaml
+- uses: tale/kubectl-action@v1
+  with:
+    base64-kube-config: ${{ secrets.KUBE_CONFIG }}
+```
+
+Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret.
+
+It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is `v1.23.0`.
+```yaml
+- uses: tale/kubectl-action@v1
+  with:
+    base64-kube-config: ${{ secrets.KUBE_CONFIG }}
+    kubectl-version: v1.22.0
+```
+
+Once you've completed this setup, you have direct access to the `kubectl` binary and command in the rest of your actions. Here's a full example to give you some inspiration:
+```yaml
+name: Kubectl Action
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: tale/kubectl-action@v1
+      with:
+        base64-kube-config: ${{ secrets.KUBE_CONFIG }}
+    - run: kubectl get pods
+```