From c4fa7b79e566a22104c8e650946b315b3aaa5be0 Mon Sep 17 00:00:00 2001 From: lepdou Date: Wed, 6 Apr 2022 20:20:10 +0800 Subject: [PATCH] update readme --- CONTRIBUTING.md | 2 +- README-zh.md | 25 ++++++++----------------- README.md | 23 ++++++++--------------- 3 files changed, 17 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c7972ac..c5b1e573 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,4 +24,4 @@ Please confirm before completing a PR: 4. Ensure a consistent code style. 5. Do adequate testing. 6. Add this pull request info to [CHANGELOG](./CHANGELOG.md). -7. Then, you can submit your code to the dev branch. \ No newline at end of file +7. Then, you can submit your code to the dev branch. diff --git a/README-zh.md b/README-zh.md index 9553842a..95030deb 100644 --- a/README-zh.md +++ b/README-zh.md @@ -48,23 +48,14 @@ Spring Cloud Tencent 使用 Maven 来构建,最快的使用方式是将本项 ```` -### 示例 - -Spring Cloud Tencent 项目包含了一个子模块spring-cloud-tencent-examples。此模块中提供了体验接入用的 example ,您可以阅读对应的 example 工程下的 readme 文档,根据里面的步骤来体验。 - -Example 列表: - -- [PolarisMesh](https://github.com/polarismesh)接入相关的样例: - - - [服务发现](spring-cloud-tencent-examples/polaris-discovery-example/README-zh.md) - - - [故障熔断](spring-cloud-tencent-examples/polaris-circuitbreaker-example/README-zh.md) - - - [限流](spring-cloud-tencent-examples/polaris-ratelimit-example/README-zh.md) - - - [网关](spring-cloud-tencent-examples/polaris-gateway-example/README-zh.md) - -更多详细功能,请参考[polaris-java](https://github.com/polarismesh/polaris-java/blob/main/README-zh.md)。 +### 使用文档 +- [Spring Cloud Tencent 版本管理](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86) +- [服务注册与发现](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Discovery-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3) +- [配置中心](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Config-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3) +- [服务限流](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Rate-Limit-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3) +- [服务熔断](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Circuitbreaker-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3) +- [服务路由](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Router-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3) +- [元数据传递](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Metadata-Transfer-%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97) ## 版本号规范 diff --git a/README.md b/README.md index b726f862..752ba57b 100644 --- a/README.md +++ b/README.md @@ -58,21 +58,14 @@ For example, Spring Cloud Tencent's 1.0.1.Hoxton.SR9 corresponds to the Spring C ```` -### Example - -Spring Cloud Tencent project contains a sub-module spring-cloud-tencent-examples. This module provides examples for users to experience, you can read the README.md in each example, and follow the instructions there. - -Example List: - -- [Polaris Discovery Example](spring-cloud-tencent-examples/polaris-discovery-example/README.md) - -- [Polaris CircuitBreaker Example](spring-cloud-tencent-examples/polaris-circuitbreaker-example/README.md) - -- [Polaris RateLimit Example](spring-cloud-tencent-examples/polaris-ratelimit-example/README.md) - -- [Polaris Gateway Example](spring-cloud-tencent-examples/polaris-gateway-example/README.md) - -For more features, please refer to [polaris-java](https://github.com/polarismesh/polaris-java). + ### Starter Usage Doc +- [Spring Cloud Tencent Version Management](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Version-Management) +- [Spring Cloud Tencent Discovery](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Discovery-Usage-Documentation) +- [Spring Cloud Tencent Config](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Config-Usage-Documentation) +- [Spring Cloud Tencent Rate Limit](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Rate-Limit-Usage-Document) +- [Spring Cloud Tencent CircuitBreaker](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Circuitbreaker-Usage-Document) +- [Spring Cloud Tencent Router](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Router-Usage-Document) +- [Spring Cloud Tencent Metadata Transfer](https://github.com/Tencent/spring-cloud-tencent/wiki/Spring-Cloud-Tencent-Metadata-Transfer-Usage-Document) ### Version Standard