From c741365e09a9ab4a05fa2cd5ef585beedaf4d34f Mon Sep 17 00:00:00 2001
From: willem-delbare <20814660+willem-delbare@users.noreply.github.com>
Date: Fri, 12 Jan 2024 13:37:35 +0100
Subject: [PATCH] clarify github-token usage

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b8b9397..bc18982 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,7 @@ Optional fields:
 - `fail-on-sast-scan`: Determines wether Aikido should block on new SAST issues. This is available in all [paid plans](https://www.aikido.dev/pricing).
 - `fail-on-iac-scan`: Determines wether Aikido should block on new Infrastructure as Code issues. This is available in all [paid plans](https://www.aikido.dev/pricing).
 - `post-scan-status-comment`: Let Aikido post a comment on the PR (when in PR context) with the latest scan status and a link to the scan results.
-- `github-token`: Optional. If the default `${{ secrets.GITHUB_TOKEN }}` environment token does not have write capabilities, Aikido needs a PAT with specific permissions to read and write comments in a PR.
+- `github-token`: Must be set only if you want Aikido to post a comment on the PR. If the default `${{ secrets.GITHUB_TOKEN }}` environment token does not have write capabilities, Aikido needs a PAT with specific permissions to read and write comments in a PR.
 
 
 ## Contributing