This is an automated email from the ASF dual-hosted git repository.
yui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu.git
The following commit(s) were added to refs/heads/master by this push:
new ceb362613 [type: build] update README.md (#3205)
ceb362613 is described below
commit ceb362613c42607933f470dd5ac4d6ae033b5150
Author: xiaoyu <[email protected]>
AuthorDate: Wed Apr 6 16:37:35 2022 +0800
[type: build] update README.md (#3205)
---
README.md | 7 +-
README_CN.md | 207 -----------------------------------------------------------
2 files changed, 4 insertions(+), 210 deletions(-)
diff --git a/README.md b/README.md
index 9d250e115..1aa1d543b 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,8 @@
<a href="https://shenyu.apache.org/docs/index" >
<img src="https://img.shields.io/badge/document-English-blue.svg" alt="EN
docs" />
</a>
- <a herf="https://shenyu.apache.org/zh/docs/index/">
- <img src="https://img.shields.io/badge/document-Chinese-blue.svg" alt="CN
docs" />
+ <a herf="https://shenyu.apache.org/zh/docs/index">
+ <img src="https://img.shields.io/badge/文档-简体中文-blue.svg" alt="简体中文文档" />
</a>
</p>
@@ -199,8 +199,9 @@ curl --location --request POST
'http://localhost:9195/shenyu/plugin/selectorAndR
---
-# Discussion and Support
+# Contributor and Support
+* [How to Contributor](https://shenyu.apache.org/community/contributor-guide)
* [Mailing Lists](mailto:[email protected])
---
diff --git a/README_CN.md b/README_CN.md
deleted file mode 100644
index b98049c59..000000000
--- a/README_CN.md
+++ /dev/null
@@ -1,207 +0,0 @@
-<p align="center" >
- <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>
-</p>
-<p align="center">
- <a href="https://shenyu.apache.org/">https://shenyu.apache.org/</a>
-</p>
-
-<p align="center">
- <a href="https://github.com/apache/shenyu/blob/master/README.md">English</a>
| 简体中文
-</p>
-
-<p align="center">
- <a target="_blank"
href="https://search.maven.org/search?q=g:org.apache.shenyu%20AND%20a:shenyu">
- <img
src="https://img.shields.io/maven-central/v/org.apache.shenyu/shenyu.svg?label=maven%20central"
/>
- </a>
- <a target="_blank"
href="https://github.com/apache/shenyu/blob/master/LICENSE">
- <img
src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license"
/>
- </a>
- <a target="_blank"
href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
- <img src="https://img.shields.io/badge/JDK-8+-green.svg" />
- </a>
- <a target="_blank" href="https://github.com/apache/shenyu/actions">
- <img src="https://github.com/apache/shenyu/workflows/ci/badge.svg" />
- </a>
- <a target="_blank" href='https://github.com/apache/shenyu'>
- <img src="https://img.shields.io/github/forks/apache/shenyu.svg"
alt="github forks"/>
- </a>
- <a target="_blank" href='https://github.com/apache/shenyu'>
- <img src="https://img.shields.io/github/stars/apache/shenyu.svg"
alt="github stars"/>
- </a>
- <a target="_blank" href='https://github.com/apache/shenyu'>
- <img
src="https://img.shields.io/github/contributors/apache/shenyu.svg" alt="github
contributors"/>
- </a>
- <a target="_blank" href="https://codecov.io/gh/apache/incubator-shenyu">
- <img
src="https://codecov.io/gh/apache/incubator-shenyu/branch/master/graph/badge.svg"
/>
- </a>
-</p>
-<br/>
-
----
-
-# 架构
-
- 
-
----
-
-# 为什么叫 ShenYu
-
-ShenYu
(神禹)是我们古代君王夏禹的尊称(后世也尊称大禹),为造福百姓,成功治理黄河水患,留下了三过家门而不入的感人故事。其和尧舜并称为中国古代最伟大的三位君王。
-
- * 首先,取名为 ShenYu 是弘扬我们中华文明的传统美德。
-
- * 其次,网关最最重要的是对流量的治理。
-
- * 最后,社区将会以公平,公正,公开,任人唯贤的做事方式,致敬神禹的同时也符合 Apache Way。
-
----
-
-# 功能特点
-
- * 提供了诸如限流、熔断、转发 、重写、重定向、路由、监控等插件;
- * 支持 HTTP、RESTFul、WebSocket、Dubbo、 gRPC、 Tars、 Spring Cloud 代理;
- * 支持热插拔,用户可以定制化开发;
- * 为了灵活的适配,选择器和规则可以动态的适配;
- * 支持集群部署;
- * 支持 A/B 测试和灰度发布。
-
----
-
-# 快速体验
-
-### 启动Apache ShenYu Admin
-
-```
-> docker pull apache/shenyu-admin
-> docker network create shenyu
-```
-
-* 使用 `h2` 来存储后台数据:
-
-```
-> docker run -d -p 9095:9095 --net shenyu apache/shenyu-admin
-```
-
-
-### 启动Apache ShenYu Bootstrap
-
-```
-> docker network create shenyu
-> docker pull apache/shenyu-bootstrap
-> docker run -d -p 9195:9195 --net shenyu apache/shenyu-bootstrap
-```
-
-### 设置路由规则
-
-* 如果你有一个这样的接口 :http://127.0.0.1:8080/helloworld,它的直接访问返回如下
-
-```json
-{
- "name" : "Shenyu",
- "data" : "hello world"
-}
-```
-
-* 单机模式设置路由规则
-
-Headers 中添加 `localKey: 123456`。如果需要自定义 localKey,可以使用 sha512 工具根据明文生成 key,并更新
`shenyu.local.sha512Key` 属性。
-
-```
-curl --location --request POST
'http://localhost:9195/shenyu/plugin/selectorAndRules' \
---header 'Content-Type: application/json' \
---header 'localKey: 123456' \
---data-raw '{
- "pluginName": "divide",
- "selectorHandler": "[{\"upstreamUrl\":\"127.0.0.1:8080\"}]",
- "conditionDataList": [{
- "paramType": "uri",
- "operator": "match",
- "paramValue": "/**"
- }],
- "ruleDataList": [{
- "ruleHandler": "{\"loadBalance\":\"random\"}",
- "conditionDataList": [{
- "paramType": "uri",
- "operator": "match",
- "paramValue": "/**"
- }]
- }]
-}'
-```
-
-* 通过网关代理请求:http://localhost:9195/helloworld 请求服务,返回如下:
-
-```json
-{
- "name" : "Shenyu",
- "data" : "hello world"
-}
-```
-
----
-
-# 插件
-
-无论请求何时进入,ShenYu 会通过响应链执行所有已打开的插件。
-
-插件是 ShenYu 的灵魂,并且插件也是可扩展和热插拔的。
-
-不同的插件实现不同的功能。
-
-当然,用户也可以定制化插件去满足他们自己的需求。
-
-如果你有定制化插件的需求,请参看这里:[custom-plugin](https://shenyu.apache.org/zh/docs/developer/custom-plugin)
。
-
----
-
-# 选择器和规则
-
-选择器和规则会根据 HTTP 的请求头来路由你的请求。
-
-选择器是你的第一个路由,它是粗粒度的,举个例子,模块级别。
-
-规则是你的第二个路由,即你认为你的请求应该做什么,举个例子,模块中的方法级别。
-
-选择器和规则只匹配一次,然后返回匹配。因此,最粗粒度应排在最后。
-
----
-
-# 数据缓存 & 数据同步
-
-所有的数据都被缓存在 JVM 的 ConcurrentHashMap 中,所以它非常快。
-
-当用户在后台界面改变配置信息时,ShenYu 通过监听 ZooKeeper 节点(或 WebSocket 推送,HTTP长轮询)来动态更新缓存。
-
-

-
-

-
----
-
-# 必要条件
-
- * JDK 1.8+
-
----
-
-# Github stars趋势
-
-[](https://starchart.cc/apache/incubator-shenyu.svg)
-
----
-
-# 讨论与支持
-
-* [邮件列表](mailto:[email protected])
-
----
-
-# 目前已知用户
-
-为了便于登记,欢迎已经使用了 ShenYu 的公司在
[https://github.com/apache/shenyu/issues/68](https://github.com/apache/shenyu/issues/68)
注册。(仅适用于开源用户)
-
-所有用户 : [Known Users](https://shenyu.apache.org/zh/community/user-registration/)