Skip to content

docs: add Chinese README translation#244

Open
Robs87 wants to merge 1 commit into
tashfeenahmed:mainfrom
Robs87:docs/chinese-readme
Open

docs: add Chinese README translation#244
Robs87 wants to merge 1 commit into
tashfeenahmed:mainfrom
Robs87:docs/chinese-readme

Conversation

@Robs87

@Robs87 Robs87 commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Problem

The project currently only has an English README, which creates a barrier for Chinese-speaking users.

Solution

  • Add README_CN.md with a complete Chinese translation
  • Add language toggle links at the top of both README.md and README_CN.md
  • Preserve all Markdown formatting, code blocks, links, and images
  • Keep technical terms (API, SDK, endpoint, token, etc.) untranslated

Why this approach

  1. Large Chinese-speaking user base — translating the README significantly lowers the adoption barrier
  2. No changes to existing format — doesn't affect other contributors
  3. Language toggle links allow easy switching between English and Chinese

Testing

  • Verified all Markdown links navigate correctly
  • Confirmed code block formatting is intact
  • Checked table rendering is normal

Happy to maintain the Chinese translation as the upstream README evolves.

- Add README_CN.md with full Chinese translation
- Add language toggle links in both README.md and README_CN.md
- Preserve all Markdown formatting, code blocks, and links
- Keep technical terms (API, SDK, endpoint, token, etc.) untranslated
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