Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example command for GitHub token usage in sp1up #2014

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

VolodymyrBg
Copy link

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 with sp1up, 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

  • Added Tests
    • N/A (Documentation change only)
  • Added Documentation
    • Added example command in installation guide
  • Breaking changes
    • No breaking changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant