Skip to content

Commit

Permalink
docs: add GitHub token usage example in installation guide (#1984)
Browse files Browse the repository at this point in the history
  • Loading branch information
CreeptoGengar authored and nhtyy committed Feb 8, 2025
1 parent c3be078 commit 4a779b6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion book/docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ If this works, go to the [next section](./quickstart.md) to compile and prove a

If you experience [rate-limiting](https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api?apiVersion=2022-11-28#rate-limiting) when using the `sp1up` command, you can resolve this by using the `--token` flag and providing your GitHub token. To create a Github token, follow the instructions [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic).

<!-- TODO: We should add an example command here -->
```bash
sp1up --token ghp_YOUR_GITHUB_TOKEN_HERE
```

#### Unsupported OS Architectures

Expand Down

0 comments on commit 4a779b6

Please sign in to comment.