From a10c556753e1f88210902cba103c00965e8e1079 Mon Sep 17 00:00:00 2001
From: JackNoordhuis <jackjnoordhuis@gmail.com>
Date: Tue, 31 Jan 2023 03:15:17 +1100
Subject: [PATCH] update README to include GITHUB_TOKEN env forwarding
 instructions

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

diff --git a/README.md b/README.md
index 6eaec2b..efc9c4e 100644
--- a/README.md
+++ b/README.md
@@ -46,9 +46,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: nxtlvlsoftware/setup-pmmp-phpstan-env-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           pmmp-version: latest
 ```
 
+Forwarding the `$GIHUB_TOKEN` environment variable is required to properly configure PocketMine sources as we
+interact with the GitHub API to fetch version information.
+
 ## License
 `nxtlvlsoftware/setup-pmmp-phpstan-env-action` is open-sourced software licensed under the [MIT license](LICENSE).