Skip to content

docs: add English README#72

Merged
luojiyin1987 merged 1 commit into
lint-md:masterfrom
hu-qi:codex/add-english-readme
Jul 6, 2026
Merged

docs: add English README#72
luojiyin1987 merged 1 commit into
lint-md:masterfrom
hu-qi:codex/add-english-readme

Conversation

@hu-qi

@hu-qi hu-qi commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add README.en-US.md as an English version of the existing Chinese README.
  • Add language switch links between the Chinese and English README files.
  • Keep the English content aligned with the current project scope, installation, Docker usage, CLI options, configuration, and exit code behavior.

Closes #71

Validation

  • npx prettier --check README.md README.en-US.md
  • npm test -- --runInBand
image

@hu-qi hu-qi marked this pull request as ready for review July 6, 2026 03:27
@luojiyin1987 luojiyin1987 self-requested a review July 6, 2026 04:38
@luojiyin1987 luojiyin1987 merged commit 06e423d into lint-md:master Jul 6, 2026
5 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.

docs: add an English README

2 participants