This is an automated email from the ASF dual-hosted git repository.
liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-java-chassis.git
The following commit(s) were added to refs/heads/master by this push:
new 6687df7bc update readme (#4131)
6687df7bc is described below
commit 6687df7bc90487cf3205e78229ccb498611b4450
Author: liubao68 <[email protected]>
AuthorDate: Wed Dec 13 15:19:49 2023 +0800
update readme (#4131)
---
README.md | 18 ++++++++++--------
README_ZH.md | 18 ++++++++++--------
2 files changed, 20 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index cfdb3a849..64b2dca56 100644
--- a/README.md
+++ b/README.md
@@ -4,16 +4,16 @@ Apache ServiceComb Java Chassis is a Software Development Kit
(SDK) for rapid de
# releases
-| Release Train | Latest Version | Compiled JDK Version | Tested JDK Version |
Open API | Notes |
-|---------------|----------------|----------------------|--------------------|----------|--------------------------|
-| 3.x.x | 3.0.0 | OpenJDK 17 | OpenJDK 17 |
3.0.x | Depends on Spring Boot 3 |
-| 2.x.x | 2.8.13 | OpenJDK 8 | OpenJDK 8, 11, 17 |
2.0.x | Depends on Spring 5 |
-| 1.x.x | 1.3.11 | OpenJDK 8 | OpenJDK 8 |
2.0.x | End of Support |
+| Release Train | Latest Version | Compiled JDK Version | Tested JDK Version
| Open API | Notes |
+|----------------|----------------|----------------------|--------------------|----------|--------------------------|
+| Java Chassis 3 | 3.0.0 | OpenJDK 17 | OpenJDK 17
| 3.0.x | Depends on Spring Boot 3 |
+| Java Chassis 2 | 2.8.13 | OpenJDK 8 | OpenJDK 8, 11, 17
| 2.0.x | Depends on Spring 5 |
+| Java Chassis 1 | 1.3.11 | OpenJDK 8 | OpenJDK 8
| 2.0.x | End of Support |
->>>NOTICE: Open API 3.0.x is not compatible with 2.0.x and Java Chassis 2.x.x
can not
-> work together with 3.x.x. All related consumers, providers and edge service
need use the 3.x.x version when upgrading.
+>>>NOTICE: Since Open API 3.0.x is not compatible with 2.0.x, Java Chassis 2
and Java Chassis 1 can not
+> work together with Java Chassis 3. All related consumers, providers and edge
service need use Java Chassis 3 when upgrading.
->>>NOTICE: Java Chassis 1.x.x reached its end of support now after it's first
release from 2018.
+>>>NOTICE: Java Chassis 1 reached its end of support now after it's first
release from 2018.
# Why use Java Chassis
@@ -77,6 +77,8 @@ public class ConsumerController {
}
```
+Try out this example
[here](https://servicecomb.apache.org/references/java-chassis/zh_CN/start/first-sample.html)
.
+
# Documentation
Project documentation is available on the [ServiceComb Java Chassis Developer
Guide][java-chassis-developer-guide].
diff --git a/README_ZH.md b/README_ZH.md
index 332534acd..46cbb39a9 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -12,15 +12,15 @@ Apache ServiceComb Java Chassis 给开发者提供一个快速构建微服务的
# releases
-| 版本火车 | 最新版本 | 编译的JDK版本 | 支持的JDK版本 | Open API | 备注
|
-|-------|--------|------------|-------------------|----------|-----------------|
-| 3.x.x | 3.0.0 | OpenJDK 17 | OpenJDK 17 | 3.0.x | 依赖Spring Boot 3
|
-| 2.x.x | 2.8.13 | OpenJDK 8 | OpenJDK 8, 11, 17 | 2.0.x | 依赖Spring 5
|
-| 1.x.x | 1.3.11 | OpenJDK 8 | OpenJDK 8 | 2.0.x | 停止更新
|
+| 版本火车 | 最新版本 | 编译的JDK版本 | 支持的JDK版本 | Open API | 备注
|
+|----------------|--------|------------|-------------------|----------|-----------------|
+| Java Chassis 3 | 3.0.0 | OpenJDK 17 | OpenJDK 17 | 3.0.x |
依赖Spring Boot 3 |
+| Java Chassis 2 | 2.8.13 | OpenJDK 8 | OpenJDK 8, 11, 17 | 2.0.x |
依赖Spring 5 |
+| Java Chassis 1 | 1.3.11 | OpenJDK 8 | OpenJDK 8 | 2.0.x | 停止更新
|
->>>NOTICE: Open API 3.0.x 不兼容 2.0.x， 因此Java Chassis 2.x.x不能与3.x.x共存互访.
升级3.x.x，需要将相关的消费者、提供者和边缘服务同时升级.
+>>>NOTICE: Open API 3.0.x 不兼容 2.0.x， 因此Java Chassis 2、Java Chassis 1不能与Java
Chassis 3共存互访. 升级Java Chassis 3, 需要将相关的消费者、提供者和边缘服务同时升级.
->>>NOTICE: Java Chassis 1.x.x 第一个版本于2018发布，目前已经停止维护.
+>>>NOTICE: Java Chassis 1 第一个版本于2018发布，已经停止更新.
# 为什么使用Java Chassis
@@ -81,6 +81,8 @@ public class ConsumerController {
}
```
+下载并体验上述[示例项目](https://servicecomb.apache.org/references/java-chassis/zh_CN/start/first-sample.html)
.
+
# 用户文档
请访问 [ServiceComb Java Chassis 开发指南][java-chassis-developer-guide].
@@ -89,7 +91,7 @@ public class ConsumerController {
# 编译Java Chassis
-开发者可以通过公有mavan仓库使用Java Chassis。 如果需要构建项目，需要使用JDK 8版本，并预先安装maven。
+开发者可以通过MAVEN仓库使用Java Chassis。 如果需要构建项目，需要使用JDK 17版本，并预先安装maven。
mvn clean install
