chore: add readme english version #336
Conversation
Signed-off-by: Young Xu <xuthus5@gmail.com>
WalkthroughThis pull request updates the project's documentation by translating and clarifying the README file for English-speaking users. The README.md file now features an English version with updated examples, including a change of the IP address to Changes
Assessment against linked issues
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
感谢您提出Pull Request，我会尽快Review。我会在1-2日内进行查看或者回复，如果遇到节假日可能会处理较慢，敬请谅解。 |
Pull Request Test Coverage Report for Build 14269483244Details
💛 - Coveralls |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
README_CN.md (4)
5-13: Badge Section Verification
All badges are present and linked appropriately. Double-check that the URLs (for build status, coverage, etc.) continue to reference valid resources.🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1941 characters long)
Context: ...en.svg?style=flat)](https://golang.org)
[
27-36: Quick Start: Code Block Language Annotation
The “快速入门” section provides the installation command; however, the fenced code block (lines 33–35) lacks a language identifier. Specifying a language (for example,bash) would improve syntax highlighting and clarity.-``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
29-29: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
31-31: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
33-33: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
37-67: Sample Code for “启动 agollo”
The example code is comprehensive and correctly demonstrates client initialization. A couple of minor points:
- The fenced code block does not specify the language (e.g.
go), which could enhance readability.- Verify that the use of the external IP (
http://106.54.227.205:8080) is intentional for the Chinese documentation.-``` +```go🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
37-37: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
39-39: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
43-43: Hard tabs
Column: 1(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1(MD010, no-hard-tabs)
54-54: Hard tabs
Column: 1(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1(MD010, no-hard-tabs)
58-58: Hard tabs
Column: 1(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1(MD010, no-hard-tabs)
61-61: Hard tabs
Column: 1(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1(MD010, no-hard-tabs)
83-96: License and Reference Information
The license and reference sections are well documented. As a minor stylistic note, if your project guidelines prefer a different heading style (for example, setext style), consider a uniform adjustment.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
84-84: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
86-86: Bare URL used
null(MD034, no-bare-urls)
87-87: Bare URL used
null(MD034, no-bare-urls)
89-89: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
93-93: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
README.md (5)
5-14: Badge Section Consistency
The badges are replicated correctly from the Chinese version. As before, verify that all external links (for build status, license, etc.) stay up-to-date over time.🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 2325 characters long)
Context: ...en.svg?style=flat)](https://golang.org)(EN_EXCESSIVE_EXCLAMATION)
15-16: English Introduction Clarity
The one-line description ("A Golang client for the configuration center framework Apollo.") is clear. Consider if “configuration management framework” might be a clearer term than “configuration center framework,” but this is optional based on your intended tone.
27-36: Quick Start Instructions and Code Block Language
The “Quick Start” section is well translated. The installation code block (lines 33–35) does not include a language tag; adding one (for example,bash) will improve readability.-``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
29-29: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
31-31: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
33-33: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
71-78: Additional Examples and Resource Links
The “More Examples” section provides useful external links and demo project references. One minor note:
- In the “Other Languages” line, there is an extra colon after the bolded text. You might consider removing one of the colons for cleaner formatting.
-***Other Languages:***: Use [agollo-agent](https://github.com/zouyx/agollo-agent.git) as a local agent for languages like PHP. +***Other Languages:*** Use [agollo-agent](https://github.com/zouyx/agollo-agent.git) as a local agent for languages like PHP.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
71-71: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
90-97: License and Reference Details
The license information and reference link to Apollo are clear. Also, if your project’s markdown style guidelines suggest a different header style (e.g., setext vs. atx), consider updating for consistency across documentation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
90-90: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
94-94: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(6 hunks)README_CN.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README_CN.md
[style] ~5-~5: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 1941 characters long)
Context: ...en.svg?style=flat)](https://golang.org)
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.17.2)
README_CN.md
17-17: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
27-27: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
29-29: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
31-31: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
33-33: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
37-37: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
39-39: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1
(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
54-54: Hard tabs
Column: 1
(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
58-58: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
61-61: Hard tabs
Column: 1
(MD010, no-hard-tabs)
63-63: Hard tabs
Column: 1
(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1
(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1
(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1
(MD010, no-hard-tabs)
70-70: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
80-80: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
84-84: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
86-86: Bare URL used
null
(MD034, no-bare-urls)
87-87: Bare URL used
null
(MD034, no-bare-urls)
89-89: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
93-93: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
README.md
17-17: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
27-27: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
29-29: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
31-31: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
33-33: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
37-37: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
62-62: Hard tabs
Column: 1
(MD010, no-hard-tabs)
71-71: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
81-81: Heading style
Expected: setext; Actual: atx
(MD003, heading-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
🔇 Additional comments (10)
README_CN.md (5)
1-4: Title and Language Toggle are Clear
The header and title clearly state the project name and offer a toggle between Chinese and English documentation.
15-16: Introduction Text in Chinese
The introductory sentence succinctly describes the client's purpose. No issues noted.
17-26: Features Section in Chinese
The bullet list of features is well formatted and clearly outlines the capabilities.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
69-76: “更多用法” Section and Demo Links
The “更多用法” section clearly presents additional resources and demo links. Consider verifying that the linked demo projects and agent repositories remain current.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
70-70: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
77-82: User and Contribution Sections
These sections are clear and provide essential links for user lists and contribution guidelines. No issues found.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
80-80: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
README.md (5)
1-4: Document Title and Language Toggle Updated
The title and the language toggle (“English | 中文”) are properly configured to direct users to the Chinese version when needed.
17-26: Features List in English
The features are listed in clear, concise bullet points. No issues detected.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
37-69: Initialization Example is Well Translated
The “Initialize agollo” code sample is clearly presented. Key updates include:
- The IP has been updated to
http://localhost:8080, which better reflects a typical local development environment.- The success message is translated to “Apollo configuration initialized successfully.”
The code block properly uses a language marker (go) at the opening fence, which is good.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
37-37: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
43-43: Hard tabs
Column: 1(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1(MD010, no-hard-tabs)
54-54: Hard tabs
Column: 1(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1(MD010, no-hard-tabs)
61-61: Hard tabs
Column: 1(MD010, no-hard-tabs)
62-62: Hard tabs
Column: 1(MD010, no-hard-tabs)
64-64: Hard tabs
Column: 1(MD010, no-hard-tabs)
65-65: Hard tabs
Column: 1(MD010, no-hard-tabs)
66-66: Hard tabs
Column: 1(MD010, no-hard-tabs)
67-67: Hard tabs
Column: 1(MD010, no-hard-tabs)
79-80: User and Issue Reporting Guidance
The instructions on how to report issues or provide feedback are clearly stated.
81-89: User and Contribution Information
The sections on users and contributions (including links to the user list, source code, and issue tracker) are well organized.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
81-81: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
85-85: Heading style
Expected: setext; Actual: atx(MD003, heading-style)
87-87: Bare URL used
null(MD034, no-bare-urls)
88-88: Bare URL used
null(MD034, no-bare-urls)
3 participants
fix: #335
Summary by CodeRabbit