Skip to content

Commit 600c3ed

Browse files
committed
docs: improve token instructions
Ensure users are aware they need to use a personal access token to have private stats show up on the card.
1 parent b9704a1 commit 600c3ed

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This action is a recommended deployment option. You can also deploy on Vercel or
6868
- `card` (required): Card type. Supported: `stats`, `top-langs`, `pin`, `wakatime`, `gist`.
6969
- `options`: Card options as a query string (`key=value&...`) or JSON. If `username` is omitted, the action uses the repository owner.
7070
- `path`: Output path for the SVG file. Defaults to `profile/<card>.svg`.
71-
- `token`: GitHub token (PAT or `GITHUB_TOKEN`).
71+
- `token`: GitHub token (PAT or `GITHUB_TOKEN`). For private repo stats, use a [PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with `repo` and `read:user` scopes.
7272

7373
## Examples
7474

@@ -120,4 +120,3 @@ with:
120120
## Notes
121121
122122
- This action uses the same renderers and fetchers as [readme-tools/github-readme-stats](https://github.com/readme-tools/github-readme-stats).
123-
- For higher API limits, use a [PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with `public_repo` scope.

0 commit comments

Comments
 (0)