Skip to content

Commit

Permalink
Change english readme as default and add contact info. (sofastack#573)
Browse files Browse the repository at this point in the history
  • Loading branch information
ujjboy authored Apr 11, 2019
1 parent 855498e commit 0880d74
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 74 deletions.
57 changes: 31 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,49 @@
![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
[![Maven](https://img.shields.io/github/release/alipay/sofa-rpc.svg)](https://github.com/alipay/sofa-rpc/releases)

SOFARPC 是一个高可扩展性、高性能、生产级的 Java RPC 框架。在蚂蚁金服 SOFARPC 已经经历了十多年及五代版本的发展。SOFARPC 致力于简化应用之间的 RPC 调用,为应用提供方便透明、稳定高效的点对点远程服务调用方案。为了用户和开发者方便的进行功能扩展,SOFARPC 提供了丰富的模型抽象和可扩展接口,包括过滤器、路由、负载均衡等等。同时围绕 SOFARPC 框架及其周边组件提供丰富的微服务治理方案。
## Overview

## 功能特性
SOFARPC is a high-performance, high-extensibility, production-level Java RPC framework. In Ant Financial, SOFARPC has been used for more than ten years and developing for five generations. SOFARPC is dedicated to simplify RPC calls between applications, and provide convenient, no code intrusion, stable, and efficient point-to-point remote service invocation solutions for applications. For user and developer easy to improve features, SOFARPC provides a wealth of model abstraction and extensible interfaces, including filter, routing, load balancing, and so on. At the same time, it provides a rich MicroService governance solution around the SOFARPC framework and its surrounding components.

- 透明化、高性能的远程服务调用
- 支持多种服务路由及负载均衡策略
- 支持多种注册中心的集成
- 支持多种协议,包括 Bolt、Rest、Dubbo 等
- 支持同步、单向、回调、泛化等多种调用方式
- 支持集群容错、服务预热、自动故障隔离
- 强大的扩展功能,可以按需扩展各个功能组件
## Features

## 关联项目
- No code intrusion, high-performance remote service call
- Supports multiple service routing and load balancing policies
- Supports multiple service registries
- Supports multiple protocols
- Supports multiple invoke type, such as synchronous, oneway, callback, generalized and more.
- Support cluster failover, service warm-up, automatic fault tolerance
- High extensibility for easy to improve features as needed

- [sofa-rpc-boot-project](https://github.com/alipay/sofa-rpc-boot-projects) SOFABoot 扩展项目,包括 starter 工程及使用示例。
## Related Projects

## 需要
- [sofa-rpc-boot-project](https://github.com/alipay/sofa-rpc-boot-projects) SOFABoot projects for SOFARPC, include starter and samples.

编译需要 JDK 8 及以上、Maven 3.2.5 及以上。
## Requirements

运行需求 JDK 8 及以上。
Build-time requirement: JDK 8 or above and Maven 3.2.5 or above.

## 文档
Runtime requirement: JDK 8 or above.

- [快速开始](http://www.sofastack.tech/sofa-rpc/docs/Getting-Started-With-SOFA-Boot)
- [用户手册](http://www.sofastack.tech/sofa-rpc/docs/Programming)
- [开发者指南](http://www.sofastack.tech/sofa-rpc/docs/How-To-Build)
- [发布历史](http://www.sofastack.tech/sofa-rpc/docs/ReleaseNotes)
- [发展路线](http://www.sofastack.tech/sofa-rpc/docs/RoadMap)

## 贡献
## Documents

[如何参与 SOFARPC 代码贡献](http://www.sofastack.tech/sofa-rpc/docs/Contributing)
- [Getting Started](http://www.sofastack.tech/sofa-rpc/docs/Getting-Started-With-SOFA-Boot?lang=en)
- [User Guide](http://www.sofastack.tech/sofa-rpc/docs/Programming?lang=en)
- [Developer Guide](http://www.sofastack.tech/sofa-rpc/docs/How-To-Build?lang=en)
- [Release Notes](http://www.sofastack.tech/sofa-rpc/docs/ReleaseNotes?lang=en)
- [Road Map](http://www.sofastack.tech/sofa-rpc/docs/RoadMap?lang=en)

## 致谢
## Contribution

SOFARPC 最早源于阿里内部的 HSF,非常感谢毕玄创造了 HSF,使 SOFARPC 的发展有了良好的基础,也非常感谢寒泉子,独明,世范在 SOFARPC 发展过程中作出的贡献,😄。
[How to Contributing](http://www.sofastack.tech/sofa-rpc/docs/Contributing?lang=en)

## 开源许可
## Contact Us

SOFARPC 基于 [Apache License 2.0](https://github.com/alipay/sofa-rpc/blob/master/LICENSE) 协议,SOFARPC 依赖了一些三方组件,它们的开源协议参见[依赖组件版权说明](http://www.sofastack.tech/sofa-rpc/docs/NOTICE)
- **DingTalk Group**

<img src="https://gw.alipayobjects.com/mdn/rms_aefe75/afts/img/A*3UUmQrZkwz0AAAAAAAAAAABjARQnAQ" height="300" width="300">

## License

SOFARPC is licensed under the [Apache License 2.0](https://github.com/alipay/sofa-rpc/blob/master/LICENSE), and SOFARPC uses some third-party components, you can view their open source license here [NOTICE](https://www.sofastack.tech/sofa-rpc/docs/NOTICE?lang=en).
47 changes: 0 additions & 47 deletions README_EN.md

This file was deleted.

55 changes: 55 additions & 0 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# SOFARPC

[![Build Status](https://travis-ci.org/alipay/sofa-rpc.svg?branch=master)](https://travis-ci.org/alipay/sofa-rpc)
[![Coverage Status](https://codecov.io/gh/alipay/sofa-rpc/branch/master/graph/badge.svg)](https://codecov.io/gh/alipay/sofa-rpc)
![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
[![Maven](https://img.shields.io/github/release/alipay/sofa-rpc.svg)](https://github.com/alipay/sofa-rpc/releases)

SOFARPC 是一个高可扩展性、高性能、生产级的 Java RPC 框架。在蚂蚁金服 SOFARPC 已经经历了十多年及五代版本的发展。SOFARPC 致力于简化应用之间的 RPC 调用,为应用提供方便透明、稳定高效的点对点远程服务调用方案。为了用户和开发者方便的进行功能扩展,SOFARPC 提供了丰富的模型抽象和可扩展接口,包括过滤器、路由、负载均衡等等。同时围绕 SOFARPC 框架及其周边组件提供丰富的微服务治理方案。

## 功能特性

- 透明化、高性能的远程服务调用
- 支持多种服务路由及负载均衡策略
- 支持多种注册中心的集成
- 支持多种协议,包括 Bolt、Rest、Dubbo 等
- 支持同步、单向、回调、泛化等多种调用方式
- 支持集群容错、服务预热、自动故障隔离
- 强大的扩展功能,可以按需扩展各个功能组件

## 关联项目

- [sofa-rpc-boot-project](https://github.com/alipay/sofa-rpc-boot-projects) SOFABoot 扩展项目,包括 starter 工程及使用示例。

## 需要

编译需要 JDK 8 及以上、Maven 3.2.5 及以上。

运行需求 JDK 8 及以上。

## 文档

- [快速开始](http://www.sofastack.tech/sofa-rpc/docs/Getting-Started-With-SOFA-Boot)
- [用户手册](http://www.sofastack.tech/sofa-rpc/docs/Programming)
- [开发者指南](http://www.sofastack.tech/sofa-rpc/docs/How-To-Build)
- [发布历史](http://www.sofastack.tech/sofa-rpc/docs/ReleaseNotes)
- [发展路线](http://www.sofastack.tech/sofa-rpc/docs/RoadMap)

## 贡献

[如何参与 SOFARPC 代码贡献](http://www.sofastack.tech/sofa-rpc/docs/Contributing)


## 联系我们

- **钉钉群**

<img src="https://gw.alipayobjects.com/mdn/rms_aefe75/afts/img/A*3UUmQrZkwz0AAAAAAAAAAABjARQnAQ" height="300" width="300">

## 致谢

SOFARPC 最早源于阿里内部的 HSF,非常感谢毕玄创造了 HSF,使 SOFARPC 的发展有了良好的基础,也非常感谢寒泉子,独明,世范在 SOFARPC 发展过程中作出的贡献,😄。

## 开源许可

SOFARPC 基于 [Apache License 2.0](https://github.com/alipay/sofa-rpc/blob/master/LICENSE) 协议,SOFARPC 依赖了一些三方组件,它们的开源协议参见[依赖组件版权说明](http://www.sofastack.tech/sofa-rpc/docs/NOTICE)
2 changes: 1 addition & 1 deletion extension-impl/registry-sofa/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.alipay.sofa</groupId>
<artifactId>sofa-rpc-extension-impl</artifactId>
<version>5.5.2-SNAPSHOT</version>
<version>5.6.0-SNAPSHOT</version>
</parent>

<groupId>com.alipay.sofa</groupId>
Expand Down

0 comments on commit 0880d74

Please sign in to comment.