docs: add example command for GitHub token usage in sp1up #2014
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The installation documentation mentions the ability to use a GitHub token with
sp1up
to avoid rate-limiting issues, but it doesn't provide a concrete example of how to use this feature. This lack of example might confuse users who are trying to resolve rate-limiting issues.Solution
Added a clear example command showing how to use the
--token
flag withsp1up
, making it immediately obvious how users should format their command when using a GitHub token.The example uses a placeholder token format that follows GitHub's standard pattern (
ghp_YOUR_GITHUB_TOKEN_HERE
), making it clear where users should insert their actual token.PR Checklist