docs: add provider referral links to README#3215
Open
TheArchitectit wants to merge 1 commit into
Open
Conversation
Add a short Providers section to README.md listing the supported API providers with links to their consoles: - Anthropic (Claude): https://console.anthropic.com/ - OpenAI: https://platform.openai.com/ - xAI (Grok): https://console.x.ai/ - DashScope (Qwen/Kimi): https://dashscope.console.aliyun.com/ This is a standalone docs-only change. The referral links were previously bundled in PR ultraworkers#2983 where they were flagged as unrelated promotional content, but in a dedicated docs PR they serve a practical purpose: helping new users find the right provider console to obtain API keys. No code changes, no behavioral changes — 9 lines added to README.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The README does not list the supported API providers or link to their consoles. New users have to hunt through USAGE.md or source code to figure out where to obtain API keys for each provider.
Solution
Add a minimal "Providers" section to README.md with one line per supported provider linking to its console/dashboard:
This is a standalone docs-only change. Similar referral links were previously included in PR #2983 but were flagged as "unrelated promotional content" because they were bundled with a PR_DESCRIPTION.md in a fix PR. In a dedicated docs PR, these links serve a practical onboarding purpose.
Changes
README.md— added 9 lines: a "Providers" section with 4 provider links, placed between "Ecosystem" and "Ownership / affiliation disclaimer"Diff verification
No upstream reverts, no deletions, no code changes.
Testing
cargo check --workspaceandcargo test— no code was changed so these should be unaffected