You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by aa...@apache.org on 2022/12/29 02:06:02 UTC
[rocketmq-clients] branch master updated: Fix typo (#329)
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new 65155e92 Fix typo (#329)
65155e92 is described below
commit 65155e9241c2bf0381f4f603a8e297f3776fc73f
Author: Aaron Ai <ya...@gmail.com>
AuthorDate: Thu Dec 29 10:05:56 2022 +0800
Fix typo (#329)
---
README-CN.md | 4 ++--
java/README-CN.md | 16 ++++++++++++----
java/README.md | 24 ++++++++++++++++--------
3 files changed, 30 insertions(+), 14 deletions(-)
diff --git a/README-CN.md b/README-CN.md
index 179e61f5..c28cabbf 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -19,7 +19,7 @@
## 设计目标
-为 Apache RocketMQ 提供包含 Java，C++，C#，Golang，JavaScript，Rust 在内的所有主流编程语言在内的云原生的，健壮的客户端解决方案。
+为 Apache RocketMQ 提供包含 Java，C++，C#，Golang，JavaScript，Rust 在内的所有主流编程语言的云原生的，健壮的客户端解决方案。
## 特性与进度
@@ -38,7 +38,7 @@
## 参与贡献
-与 Apache RocketMQ 的其他项目类似，我们欢迎任何形式的贡献，包括但不仅限于提交 bug 报告、勘误纠错、文档撰写或提交 feature。从第一个 issue/pull request 开始！
+与 Apache RocketMQ 的其他项目类似，我们欢迎任何形式的贡献，包括但不仅限于提交 bug 报告、勘误纠错、文档撰写或提交 feature。成为 Apache RocketMQ contributor，从第一个 issue/pull request 开始！
## 相关链接
diff --git a/java/README-CN.md b/java/README-CN.md
index 1ce1be29..c077671e 100644
--- a/java/README-CN.md
+++ b/java/README-CN.md
@@ -22,11 +22,15 @@
<artifactId>rocketmq-client-java</artifactId>
<version>${rocketmq.version}</version>
</dependency>
+```
-<!-- Groovy Kotlin DSL for Gradle -->
+```kotlin
+// Kotlin DSL for Gradle
implementation("org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}")
+```
-<!-- Groovy DSL for Gradle -->
+```groovy
+// Groovy DSL for Gradle
implementation 'org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}'
```
@@ -41,11 +45,15 @@ implementation 'org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}'
<artifactId>rocketmq-client-java-noshade</artifactId>
<version>${rocketmq.version}</version>
</dependency>
+```
-<!-- Groovy Kotlin DSL for Gradle -->
+```kotlin
+// Kotlin DSL for Gradle
implementation("org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.version}")
+```
-<!-- Groovy DSL for Gradle -->
+```groovy
+// Groovy DSL for Gradle
implementation 'org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.version}'
```
diff --git a/java/README.md b/java/README.md
index 95fa9a7f..060a04dd 100644
--- a/java/README.md
+++ b/java/README.md
@@ -13,7 +13,7 @@ Here are some preparations you may need to know (or refer to [here](https://rock
## Getting Started
-Dependencies must be included in accordance with your build automation tools, and replace the `${rocketmq.version}` with the [latest version]((https://search.maven.org/search?q=g:org.apache.rocketmq%20AND%20a:rocketmq-client-java)).
+Dependencies must be included in accordance with your build automation tools, and replace the `${rocketmq.version}` with the [latest version](https://search.maven.org/search?q=g:org.apache.rocketmq%20AND%20a:rocketmq-client-java).
```xml
<!-- For Apache Maven -->
@@ -22,15 +22,19 @@ Dependencies must be included in accordance with your build automation tools, an
<artifactId>rocketmq-client-java</artifactId>
<version>${rocketmq.version}</version>
</dependency>
+```
-<!-- Groovy Kotlin DSL for Gradle -->
+```kotlin
+// Kotlin DSL for Gradle
implementation("org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}")
+```
-<!-- Groovy DSL for Gradle -->
+```groovy
+// Groovy DSL for Gradle
implementation 'org.apache.rocketmq:rocketmq-client-java:${rocketmq.version}'
```
-The `rocketmq-client-java` is a shaded jar, which means its dependencies can not be manually changed. While we still offer the no-shaded jar for exceptional situations, use the shaded one if you are unsure which version to use. In the majority of cases, this is a good technique for dealing with library dependencies that clash with one another.
+The `rocketmq-client-java` is a shaded jar, which means its dependencies can not be manually changed. While we still offer the no-shaded jar for exceptional situations, use the shaded one if you are unsure which version to use. In most cases, this is a good technique for dealing with library dependencies that clash with one another.
```xml
<!-- For Apache Maven -->
@@ -39,21 +43,25 @@ The `rocketmq-client-java` is a shaded jar, which means its dependencies can not
<artifactId>rocketmq-client-java-noshade</artifactId>
<version>${rocketmq.version}</version>
</dependency>
+```
-<!-- Groovy Kotlin DSL for Gradle -->
+```kotlin
+// Kotlin DSL for Gradle
implementation("org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.version}")
+```
-<!-- Groovy DSL for Gradle -->
+```groovy
+// Groovy DSL for Gradle
implementation 'org.apache.rocketmq:rocketmq-client-java-noshade:${rocketmq.version}'
```
-You can see more code examples [here](./client/src/main/java/org/apache/rocketmq/client/java/example).
+More code examples are provided [here](./client/src/main/java/org/apache/rocketmq/client/java/example) to assist you in working with various clients and different message types.
## Logging System
We picked [Logback](https://logback.qos.ch/) and shaded it into the client implementation to guarantee that logging is reliably persistent. Because RocketMQ utilizes a distinct configuration file, you shouldn't be concerned that the Logback configuration file will clash with yours.
-The following logging parameters are all supported for specification by JVM system parameters (for example, "java -Drocketmq.log.level=INFO -jar foobar.jar") or environment variables.
+The following logging parameters are all supported for specification by JVM system parameters (for example, `java -Drocketmq.log.level=INFO -jar foobar.jar`) or environment variables.
* `rocketmq.log.level`: log output level, default is INFO.
* `rocketmq.log.root`: the root directory of the log output, default is the current user's HOME directory.