From c4da4a81aa7b773021207dc25322848e03fcfb57 Mon Sep 17 00:00:00 2001
From: Stefan Prodan <stefan.prodan@gmail.com>
Date: Thu, 17 Dec 2020 13:29:03 +0200
Subject: [PATCH] Add note about ignoring flux action binary

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
---
 action/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/action/README.md b/action/README.md
index 61334822..70aa2e7c 100644
--- a/action/README.md
+++ b/action/README.md
@@ -10,6 +10,16 @@ Usage:
         run: flux -v
 ```
 
+This action places the `flux` binary inside your repository root under `bin/flux`.
+You should add `bin/flux` to your `.gitingore` file like so:
+
+```gitignore
+# ignore flux binary
+bin/flux
+```
+
+Note that this action can only be used on GitHub **Linux AMD64** runners.
+
 ### Automate Flux updates
 
 Example workflow for updating Flux's components generated with `flux bootstrap --arch=amd64 --path=clusters/production`: