This is an automated email from the ASF dual-hosted git repository. midnight2104 pushed a commit to branch midnight2104 in repository https://gitbox.apache.org/repos/asf/incubator-shenyu.git
commit 07bc0f299f880b9ce265e974dae862a70f63b859 Author: LL2104 <[email protected]> AuthorDate: Wed Mar 16 20:55:58 2022 +0800 update readme --- README.md | 14 +++++++------- README_CN.md | 16 ++++++++-------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 086eded..25711cc 100644 --- a/README.md +++ b/README.md @@ -64,11 +64,11 @@ He is known as one of the three greatest kings of ancient China, along with Yao # Features - * ShenYu provides ability such as current limiting, fusing, forwarding, routing monitoring and so on by its plugins. + * ShenYu provides ability such as current limiting, fusing, forwarding, routing, monitoring and so on by its plugins. - * Support HTTP, RESTFul, WebSocket, Dubbo, GRPC, Tars and Spring Cloud Proxy. + * Support HTTP, RESTFul, WebSocket, Dubbo, gRPC, Tars and Spring Cloud Proxy. - * Plug-in hot plug, users can customize the development. + * Plugin hot plug, users can customize the development. * Selectors and rules are dynamically configured for flexible matching. @@ -154,11 +154,11 @@ curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndR Of course, users can also customize plugins to meet their own needs. - If you want to customize, see [custom-plugin](https://shenyu.apache.org/docs/developer/custom-plugin/) + If you want to customize, see [custom-plugin](https://shenyu.apache.org/docs/developer/custom-plugin/) . -------------------------------------------------------------------------------- -# Selector & rule +# Selector & Rule According to your HTTP request headers, selectors and rules are used to route your requests. @@ -174,7 +174,7 @@ curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndR Since all data have been cached using ConcurrentHashMap in the JVM, it's very fast. - When user have changed the configuration in the background management, ShenYu will dynamically updates its cache by listening to the ZooKeeper node, WebSocket push, HTTP longPull. + ShenYu dynamically updates the cache by listening to the ZooKeeper node (or WebSocket push, HTTP long polling) when the user changes configuration information in the background management.  @@ -203,6 +203,6 @@ curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndR # Known Users -In order of registration, More access companies are welcome to register at [https://github.com/apache/incubator-shenyu/issues/68](https://github.com/apache/incubator-shenyu/issues/68) (For open source users only) +In order of registration, More access companies are welcome to register at [https://github.com/apache/incubator-shenyu/issues/68](https://github.com/apache/incubator-shenyu/issues/68) (For open source users only) . All Users : [Known Users](https://shenyu.apache.org/community/user-registration) diff --git a/README_CN.md b/README_CN.md index 9b2792d..33a69a7 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,7 +2,7 @@ <a href="https://dromara.org";><img src="https://shenyu.apache.org/img/logo/apache-shenyu.png"; width="45%"></a> </p> <p align="center"> - <strong>应用于所有微服务场景的，可扩展、高性能、响应式的 API 网关解决方案</strong> + <strong>应用于所有微服务场景，可扩展、高性能、响应式的 API 网关解决方案</strong> </p> <p align="center"> <a href="https://shenyu.apache.org/";>https://shenyu.apache.org/</a> @@ -48,22 +48,22 @@ -------------------------------------------------------------------------------- -# 为什么叫ShenYu +# 为什么叫 ShenYu ShenYu (神禹)是我们古代君王夏禹的尊称（后世也尊称大禹），为造福百姓，成功治理黄河水患，留下了三过家门而不入的感人故事。其和尧舜并称为中国古代最伟大的三位君王。 - * 首先，取名为ShenYu是弘扬我们中华文明的传统美德。 + * 首先，取名为 ShenYu 是弘扬我们中华文明的传统美德。 * 其次，网关最最重要的是对流量的治理。 - * 最后，社区将会以公平，公正，公开，任人唯贤的做事方式，致敬神禹的同时也符合Apache Way。 + * 最后，社区将会以公平，公正，公开，任人唯贤的做事方式，致敬神禹的同时也符合 Apache Way。 -------------------------------------------------------------------------------- # 功能特点 - * 提供了诸如限流、熔断、转发 、重写、重定向、和路由监控等插件； - * 支持 HTTP、RESTFul、WebSocket、Dubbo、 GRPC、 Tars、 Spring Cloud 代理； + * 提供了诸如限流、熔断、转发 、重写、重定向、路由、监控等插件； + * 支持 HTTP、RESTFul、WebSocket、Dubbo、 gRPC、 Tars、 Spring Cloud 代理； * 支持热插拔，用户可以定制化开发； * 为了灵活的适配，选择器和规则可以动态的适配； * 支持集群部署； @@ -154,7 +154,7 @@ curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndR 当然，用户也可以定制化插件去满足他们自己的需求。 -如果你有定制化插件的需求，请参看这里：[custom-plugin](https://shenyu.apache.org/zh/docs/developer/custom-plugin) +如果你有定制化插件的需求，请参看这里：[custom-plugin](https://shenyu.apache.org/zh/docs/developer/custom-plugin) 。 -------------------------------------------------------------------------------- @@ -174,7 +174,7 @@ curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndR 所有的数据都被缓存在 JVM 的 ConcurrentHashMap 中，所以它非常快。 -当用户在后台界面改变配置信息时，ShenYu 通过监听 ZooKeeper node，WebSocket push，HTTP longPull 来动态更新缓存。 +当用户在后台界面改变配置信息时，ShenYu 通过监听 ZooKeeper 节点（或 WebSocket 推送，HTTP长轮询）来动态更新缓存。 
![https://shenyu.apache.org/img/logo/apache-shenyu.png"](https://shenyu.apache.org/img/logo/apache-shenyu.png"){kind=link}
