resolves #61, updating documentation for use with self-hosted GitHub … (#62)

bwhitehead0 · bwhiteh4 · elgohr · web-flow · commit 424294aa3f10 · 2024-10-31T00:12:29.000+01:00
* resolves #61, updating documentation for use with self-hosted GitHub Enterprise * Reformulate selfhosted message --------- Co-authored-by: Whitehead, Brandon <bwhiteh4@wm.com> Co-authored-by: Lars Gohr <elgohr@users.noreply.github.com>
diff --git a/README.md b/README.md
@@ -53,4 +53,21 @@ permissions:
   contents: write
 ```
 
-to the concrete job creating the release. For more details see the [documentation on token permissions.](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)
+to the concrete job creating the release. For more details see the [documentation on token permissions.](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token)
+
+### Use with GitHub Enterprise
+
+To publish your release to self-hosted GitHub Enterprise, include `GH_ENTERPRISE_TOKEN` and `GH_HOST` as environment variables.  
+For example:
+
+```yaml
+      - name: Create Release
+        if: ${{ github.event.inputs.create_release }}
+        uses: elgohr/Github-Release-Action@v5
+        env:
+          GH_ENTERPRISE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_HOST: yourgithub.company.com
+        with:
+          title: "New release"
+          tag: "v1.0.1"
+```
