Add example

Roblox · Mar 5, 2024 · 046168e · 046168e
1 parent 8a2e0ea
commit 046168e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,5 +40,14 @@ value as the current environment, which will usually be
 This parameter exists primarily to allow GitHub Enterprise to point back to
 GitHub Cloud to install publicly hosted tools.
 
+As such, for any use of this action in GitHub Enterprise, `github-api-url`
+should be included like so:
+```yaml
+- uses: Roblox/setup-foreman@v1
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }}
+    github-api-url: "https://api.github.com"
+```
+
 ## License
 setup-foreman is available under the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for details.