From e073bd0f5c2a1b383ffaee047ebfe0d6369abca2 Mon Sep 17 00:00:00 2001
From: Paul Loberg <pal.loberg@telenorlinx.com>
Date: Fri, 27 Sep 2024 11:01:55 +0200
Subject: [PATCH] Update README with instructions on GHES usage.

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

diff --git a/README.md b/README.md
index d412f19..6b9bcde 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,19 @@ With configure, call it with:
 ./configure CC="sccache clang" CXX="sccache clang"
 ```
 
+## Using on GitHub Enterprise Server (GHES)
+
+When using the action on GitHub Enterprise Server installations a valid GitHub.com token must be provided.
+
+```
+- name: Run sccache-cache
+  uses: mozilla-actions/sccache-action@v0.0.5
+  with:
+    token: ${{ secrets.MY_GITHUB_TOKEN }}
+```
+
+Note that using https://github.com/actions/create-github-app-token is a better option than storing a fixed token in the repo secrets.
+
 ## Prepare a new release
 
 1. Update the example in README.md