diff --git a/README.md b/README.md index 39980a34c..052a803cb 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 open source middleware and makes it easy to develop distributed service or 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