Skip to content

docs: clarify API key requirements and simplify structure#13

Merged
oscarvalenzuelab merged 1 commit into
mainfrom
docs/clarify-api-key-requirements
Apr 3, 2026
Merged

docs: clarify API key requirements and simplify structure#13
oscarvalenzuelab merged 1 commit into
mainfrom
docs/clarify-api-key-requirements

Conversation

@oscarvalenzuelab
Copy link
Copy Markdown
Contributor

Summary

  • Clarify that API keys are free and require the check scope in permissions
  • Simplify the API Modes table (removed URL column, focus on use case)
  • Make "Getting an API Key" section more prominent and concise

Changes

  • Updated README.md with clearer API key instructions
  • Consistent with changes made to the JS SDK and proxydocker docs

- Clarify API keys are free and require `check` scope
- Move "Getting an API Key" section right after API Modes
- Simplify API modes table (remove URL column, focus on use case)
@cla-bot cla-bot Bot added the cla-signed label Apr 3, 2026
@oscarvalenzuelab oscarvalenzuelab merged commit 6fd6804 into main Apr 3, 2026
7 checks passed
@oscarvalenzuelab oscarvalenzuelab deleted the docs/clarify-api-key-requirements branch April 3, 2026 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant