Skip to content

docs: update README for v0.4.2 downloads and HRouter quick start - #21

Merged
honestTai merged 1 commit into
mainfrom
cursor/readme-discoverability-f65e
Oct 21, 2026
Merged

honestTai merged 1 commit into
mainfrom
cursor/readme-discoverability-f65e

Conversation

@honestTai

Copy link
Copy Markdown
Owner

Summary / 概述

Updates the English and Chinese READMEs so the repository matches the current GitHub release and explains how to start with an HRouter key. No application code changes.

  • Latest release is v0.4.2 (2026-10-09), not v0.4.0. Download badges and the install table now link to HRouter_0.4.2_aarch64.dmg and HRouter_0.4.2_x64-setup.exe. Intel Macs stay unsupported, matching the release notes and updater targets (darwin-aarch64, windows-x86_64).
  • The top of each README states the workbench value in one line, keeps the existing screenshot, and lists the agents it covers.
  • New Quick start with HRouter / 用 HRouter 快速开始 section: create a key at hrouter.net, then use Add HRouter key / 添加 HRouter Key and 识别 Key in the app.
  • New base URL section, taken from the HRouter docs (not invented):
    • Claude Code: https://hrouter.net (ANTHROPIC_BASE_URL) — tutorial
    • Codex and other OpenAI-compatible clients: https://hrouter.net/v1 — tutorial
  • Keywords used in the existing prose: Claude Code, Codex, API relay, LLM gateway, OpenAI-compatible, CC Switch alternative. No “never banned” or refund claims. The historical note that v0.4.0 removed account, payment, and order modules is unchanged.
  • Screenshot provenance no longer reads as if v0.4.0 were the current notarized release.

Related Issue / 关联 Issue

None. Documentation-only discoverability update.

Screenshots / 截图

Not applicable. This PR edits README text and does not change the app UI. Existing screenshot assets are unchanged.

Checklist / 检查清单

  • Documentation only; no TypeScript, Rust, or user-facing app strings changed
  • pnpm typecheck — not run; no code changes
  • pnpm format:check — not run; no code changes
  • cargo clippy — not applicable
  • i18n files — not applicable

Repo topics / 仓库主题

This environment’s GitHub CLI is read-only, so topics were not changed. Current topics: claude-code, codex, desktop-app, gemini-cli, grok, tauri, hrouter, ai-tools.

Please add, keeping the existing ones: api-relay, llm-gateway, openai-compatible, cc-switch, claude-code-router.

Open in Web Open in Cursor 

Update the English and Chinese READMEs with the current release downloads,
a short HRouter key quick start, and the documented Claude Code and Codex base URLs.

Co-authored-by: HRouter <honestTai@users.noreply.github.com>
@honestTai
honestTai marked this pull request as ready for review October 21, 2026 16:33
@honestTai
honestTai merged commit b69416c into main Oct 21, 2026
4 checks passed
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.

2 participants