📝 add documentation on the GitHub authentication token

README.md

@@ -17,6 +17,7 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs
   - [Enable Caching](#enable-caching)
     - [Local cache path](#local-cache-path)
     - [Cache dependency glob](#cache-dependency-glob)
+  - [GitHub authentication token](#github-authentication-token)
 - [How it works](#how-it-works)
 - [FAQ](#faq)
 
@@ -134,6 +135,23 @@ changes. The glob matches files relative to the repository root.
       '**pyproject.toml'
 ```
 
+### GitHub authentication token
+
+This action uses the GitHub API to fetch the `uv` release artifacts. To avoid hitting the GitHub API
+rate limit too quickly, an authentication token can be provided via the `github-token` input. By
+default, the `GITHUB_TOKEN` secret is used, which is automatically provided by GitHub Actions.
+
+If the default
+[permissions for the GitHub token](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)
+are not sufficient, you can provide a custom GitHub token with the necessary permissions.
+
+```yaml
+- name: Install the latest version of uv with a custom GitHub token
+  uses: astral-sh/setup-uv@v2
+  with:
+    github-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
+```
+
 ## How it works
 
 This action downloads uv from the uv repo's official