From ca09235f0f5d728b4ebb27c7615ee79b221fea77 Mon Sep 17 00:00:00 2001 From: rancho Date: Fri, 14 Apr 2023 11:42:46 +0800 Subject: [PATCH] Update README. --- README-zh.md | 91 +++++++++++++++++++++------------------------------- README.md | 84 +++++++++++++++++++++--------------------------- 2 files changed, 74 insertions(+), 101 deletions(-) diff --git a/README-zh.md b/README-zh.md index d9add8859..edfb634a5 100644 --- a/README-zh.md +++ b/README-zh.md @@ -10,53 +10,51 @@ [English](./README.md) | 简体中文 ---- +README: + +- [介绍](#介绍) +- [如何构建](#如何构建) +- [如何使用](#如何使用) +- [使用示例](#使用示例) + +更多文档请查看[Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki) ## 介绍 -> 欢迎各位同学点击右上角 Star 按钮，持续关注我们的项目，给予我们最大的支持~ +Spring Cloud Tencent 是基于 Spring Cloud SPI 实现的一站式微服务解决方案。通过集成 Spring Cloud 和腾讯中间件，让分布式服务和微服务的开发、测试、发布和运维变得更加简单。 -Spring Cloud Tencent 是腾讯开源的一站式微服务解决方案。 + -Spring Cloud Tencent 实现了Spring Cloud 标准微服务 SPI，开发者可以基于 Spring Cloud Tencent 快速开发 Spring Cloud -云原生分布式应用。 +**服务发现和治理** -Spring Cloud Tencent 的核心依托腾讯开源的一站式服务发现与治理平台 [PolarisMesh](https://polarismesh.cn/) -，实现各种分布式微服务场景。 +Spring Cloud Tencent 集成 Spring Cloud 和北极星。北极星是一个支持多语言和多框架的服务发现和治理平台。 -- [Polaris Github home page](https://github.com/polarismesh/polaris) -- [Polaris official website](https://polarismesh.cn/) +- [北极星 Github](https://github.com/polarismesh/polaris) -Spring Cloud Tencent提供的能力包括但不限于： +Spring Cloud 集成北极星可以解决以下问题： -image +- 服务管理：服务发现、服务发现、健康检查 +- 流量控制：可自定义的流量路由、负载均衡、限频限流、访问控制 +- 故障容错：服务和接口熔断和降级、实例熔断和切换 +- 配置管理：版本管理、灰度发布、动态更新 -- 服务注册和发现 -- 动态配置管理 -- 服务治理 - - 服务限流 - - 服务熔断 - - 服务路由 - - ... -- 标签透传 +## 如何构建 -## 体验环境 +运行以下命令进行构建。 -- 管控台地址： http://14.116.241.63:8080/ - - 账号：polaris - - 密码：polaris -- 控制面地址： `grpc://183.47.111.80:8091` -- +**Linux and Mac** -`spring-cloud-tencent-example` 下 example 地址都默认指向了体验服务地址（`grpc://183.47.111.80:8091`），如果您只是体验 -Spring Cloud -Tencent，可直接一键运行任何 example。 +``` +./mvnw clean package +``` -## 管控台 +**Windows** -sc +``` +.\mvnw.cmd clean package +``` -## 使用指南 +## 如何使用 Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要引入依赖即可。 @@ -96,36 +94,21 @@ Spring Cloud Tencent 所有组件都已上传到 Maven 中央仓库，只需要 ```` -## 开发入门 +## 使用示例 -You can build this project with command: +北极星为开发者提供体验环境： -```shell -## MacOS or Linux -./mvnw clean package +- [北极星控制台](http://14.116.241.63:8080) +- 北极星服务端地址：`grpc://183.47.111.80:8091` -## Win -.\mvnw.cmd clean package -``` - -## 文档 - -请阅读 [Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki) +在 spring-cloud-tencent-example 项目里，北极星服务端地址默认配置为`grpc://183.47.111.80:8091`。 ## 交流群 -扫描下面的二维码加入 Spring Cloud Tencent 交流群。 +扫码二维码，加入 Spring Cloud Tencent 交流群。欢迎用户反馈使用问题和优化建议。 - - -## License - -The spring-cloud-tencent is licensed under the BSD 3-Clause License. Copyright and license information can be found in -the file [LICENSE](LICENSE) + ## Stargazers over time -如果您对 Spring Cloud Tencent 有兴趣，请关注我们的项目~ - -[![Stargazers over time](https://starchart.cc/Tencent/spring-cloud-tencent.svg)](https://starchart.cc/Tencent/spring-cloud-tencent) - +[![](https://starchart.cc/Tencent/spring-cloud-tencent.svg)](https://starchart.cc/Tencent/spring-cloud-tencent) diff --git a/README.md b/README.md index 161993130..a9d2b0caf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ Spring-Cloud-Tencent-Logo - [![Wiki](https://badgen.net/badge/icon/wiki?icon=wiki&label)](https://github.com/Tencent/spring-cloud-tencent/wiki) [![Maven Central](https://img.shields.io/maven-central/v/com.tencent.cloud/spring-cloud-tencent?label=Maven%20Central)](https://search.maven.org/search?q=g:com.tencent.cloud%20AND%20a:spring-cloud-tencent) [![Contributors](https://img.shields.io/github/contributors/Tencent/spring-cloud-tencent)](https://github.com/Tencent/spring-cloud-tencent/graphs/contributors) @@ -11,48 +10,51 @@ English | [简体中文](./README-zh.md) +README: + +- [Introduction](#introduction) +- [How to build](#how-to-build) +- [How to use](#how-to-use) +- [Examples](#examples) + +Visit [Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki) to learn more + ## Introduction -Spring Cloud Tencent is a open source one-stop microservice solution from Tencent. +Spring Cloud Tencent is an one-stop microservice solution which implements the standard Spring Cloud SPI. It integrates Spring Cloud with Tencent middlewares and makes it easy to develop microservice. -Spring Cloud Tencent implements the Spring Cloud standard microservice SPI, so developers can quickly develop Spring -Cloud cloud-native distributed applications based on Spring Cloud Tencent. + -The core of Spring Cloud Tencent relies on Tencent's open-source one-stop service discovery and governance -platform [PolarisMesh](https://polarismesh.cn) to realize various distributed microservice scenarios. +**Service discovery and governance** -- [PolarisMesh Github home page](https://github.com/polarismesh/polaris) -- [PolarisMesh official website](https://polarismesh.cn/) +Spring Cloud Tencent integrates Spring Cloud with Polaris which is an open source system for service discovery and governance. -The capabilities provided by Spring Cloud Tencent include but are not limited to: +- [Polaris Github](https://github.com/polarismesh/polaris) -image +Spring Cloud with Polaris can solve these problem: -- Service registration and discovery -- Dynamic configuration management -- Service Governance - - Service rate limit - - Service circuit breaker - - Service routing - - ... -- Label transparent transmission +- service management: service discovery, service registry and health check +- traffic control: customizable routing, load balance, rate limiting and access control +- fault tolerance: circuit breaker for service, interface and instance +- config management: config version control, grayscale release and dynamic update -## Demo Environment +## How to build -- Console Address : http://14.116.241.63:8080/ - - Username: polaris - - Password: polaris -- Server Address: `grpc://183.47.111.80:8091` +Run these commands to build this project as follow. -The example addresses under `spring-cloud-tencent-example` all point to the experience service -address (`grpc://183.47.111.80:8091`) by default. If you only experience Spring Cloud Tencent, you can run any example -directly with one click. +**Linux and Mac** -## Screenshots +``` +./mvnw clean package +``` -sc +**Windows** + +``` +.\mvnw.cmd clean package +``` -## Use Guide +## How to use All the components of Spring Cloud Tencent have been uploaded to the Maven central repository, just need to introduce dependencies. @@ -93,32 +95,20 @@ For example: ```` -## Develop Guide +## Examples -You can build this project with command: +The experience environment of Polaris is provided for developers: -```shell -## MacOS or Linux -./mvnw clean package +- [Polaris Console](http://14.116.241.63:8080) +- Polaris Server Address: `grpc://183.47.111.80:8091` -## Win -.\mvnw.cmd clean package -``` - -## Documents - -Pelease refer to [Wiki](https://github.com/Tencent/spring-cloud-tencent/wiki) +The address of Polaris server in spring-cloud-tencent-example is `grpc://183.47.111.80:8091` by default. ## Chat Group Please scan the QR code to join the chat group. - - -## License - -The spring-cloud-tencent is licensed under the BSD 3-Clause License. Copyright and license information can be found in -the file [LICENSE](LICENSE) + ## Stargazers over time