From 60604481dbdfb34bc94347ff8a29d74cd498f100 Mon Sep 17 00:00:00 2001
From: Erik Kristensen <erik@erikkristensen.com>
Date: Mon, 9 Jan 2023 08:29:54 -0700
Subject: [PATCH] docs: add authentication snippet example

Signed-off-by: Erik Kristensen <erik@erikkristensen.com>
---
 action/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/action/README.md b/action/README.md
index c00c8aa3..aec67add 100644
--- a/action/README.md
+++ b/action/README.md
@@ -35,6 +35,18 @@ You can download a specific version with:
           version: 0.32.0
 ```
 
+You can also authentication to the GitHub API using a secret
+
+```yaml
+    steps:
+      - name: Setup Flux CLI
+        uses: fluxcd/flux2/action@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+This is useful if you are seeing failures on shared runners, those failures are usually API limits being hit.
+
 ### Automate Flux updates
 
 Example workflow for updating Flux's components generated with `flux bootstrap --path=clusters/production`: