This is an automated email from the ASF dual-hosted git repository. liubao pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/servicecomb-fence.git
commit 3d0ee93eb3730ef5133af6436613b5ee543535c6 Author: liubao <[email protected]> AuthorDate: Fri May 31 17:38:47 2019 +0800 [SCB-1293]update readme and seperate english and zh_cn --- README.md | 36 ++++++------------------------------ README.md => README_ZH.md | 32 +++++--------------------------- 2 files changed, 11 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 8befb72..cc9dbcb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# English +# Fence | [中文](README_ZH.md) [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://gitter.im/ServiceCombUsers/Lobby) -This project is servicecomb-java-chassis security support. The main architecture is based on [The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749) and [OpenID Connect](https://openid.net/connect/). And provides APIs for developers based on [Spring Security](https://spring.io/projects/spring-security). Please see [developers guide](docs/en_US/developersGuide.md) for details. +This project is servicecomb-java-chassis security support. The main architecture is based on [The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749) and [OpenID Connect](https://openid.net/connect/). And provides APIs for developers based on [Spring Security](https://spring.io/projects/spring-security). Please see [developers guide](docs/zh_CN/developersGuide.md) for details. ## Project description @@ -24,31 +24,7 @@ http://localhost:9093/v1/test/start see AuthenticationTestCase for testing details. - -# 中文 -本项目为servicecomb-java-chassis提供认证鉴权支持。鉴权实现的主要框架参考了[The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749) 和 [OpenID Connect](https://openid.net/connect/)。项目参考[Spring Security](https://spring.io/projects/spring-security)给开发者提供了接口。请参考[开发指南](docs/zh_CN/developersGuide.md)获取详细信息。 - -## 项目说明 - -项目包含了api和samples两个目录。其中api目录主要提供给Authentication Server, Edge Service and Resource Server使用的api。 samples目录是基于上诉api提供的一个开发示例。 - -* 编译和运行 - - -``` -cd samples -mvn clean install -``` - -编译完成后，会生成Authentication Server, Resource Server, Edge Service and Testing Client可执行jar包，运行这四个服务。 - -* 运行测试用例 - -当四个服务都运行起来后，访问： - -``` -http://localhost:9093/v1/test/start -``` - -可以通过查看AuthenticationTestCase了解测试用例的详情。 - +## Contact Us +* [issues](https://issues.apache.org/jira/browse/SCB) +* [gitter](https://gitter.im/ServiceCombUsers/Lobby) +* mailing list: [subscribe](mailto:[email protected]) [view](https://lists.apache.org/[email protected]) diff --git a/README.md b/README_ZH.md similarity index 50% copy from README.md copy to README_ZH.md index 8befb72..cf893d4 100644 --- a/README.md +++ b/README_ZH.md @@ -1,31 +1,5 @@ -# English +# Fence | [English](README.md) [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://gitter.im/ServiceCombUsers/Lobby) -This project is servicecomb-java-chassis security support. The main architecture is based on [The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749) and [OpenID Connect](https://openid.net/connect/). And provides APIs for developers based on [Spring Security](https://spring.io/projects/spring-security). Please see [developers guide](docs/en_US/developersGuide.md) for details. - -## Project description - -This project contains two folders api and samples. Api folder contains components used in Authentication Server, Edge Service and Resource Server. And samples folder gives a working example showing how to use these apis. - -* Build and run - -``` -cd samples -mvn clean install -``` - -After build, the Authentication Server, Resource Server, Edge Service and Testing Client runnable jar are generated, start and run the four services. - -* Run tests - -After services are started, try -``` -http://localhost:9093/v1/test/start -``` - -see AuthenticationTestCase for testing details. - - -# 中文 本项目为servicecomb-java-chassis提供认证鉴权支持。鉴权实现的主要框架参考了[The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749) 和 [OpenID Connect](https://openid.net/connect/)。项目参考[Spring Security](https://spring.io/projects/spring-security)给开发者提供了接口。请参考[开发指南](docs/zh_CN/developersGuide.md)获取详细信息。 ## 项目说明 @@ -52,3 +26,7 @@ http://localhost:9093/v1/test/start 可以通过查看AuthenticationTestCase了解测试用例的详情。 +## 联系我们 +* [提交issues](https://issues.apache.org/jira/browse/SCB) +* [gitter聊天室](https://gitter.im/ServiceCombUsers/Lobby) +* 邮件列表: [订阅](mailto:[email protected]) [浏览](https://lists.apache.org/[email protected])
