Skip to content

Commit

Permalink
add README.md in english (#257)
Browse files Browse the repository at this point in the history
  • Loading branch information
saintping authored Oct 23, 2019
1 parent e4157bd commit 5e6b5d8
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 21 deletions.
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 成为贡献者

### 提交特性/修复问题
#### 提交特性/修复问题

**Note:** 请先填写`issue`,在进入`Pull`请求之前,获得充分的反馈!

Expand All @@ -14,26 +14,25 @@
- 提交`PR`后,请邀请`Reviewers`进行`review`。只有`review`过的代码,才可能被合入。


### 审查PR
#### 审查PR

为WeEvent做出贡献的另一个非常有用的方法,审查其他人的`Pull`请求。获得多人的反馈非常有帮助,减少`Pull Request`做出最终决定的总时间。

### 编写文档
#### 编写文档

我们的文档位于[docs](https://weeventdoc.readthedocs.io/zh_CN/latest/)目录中的GitHub上。你看到一个错字或其他方法来改善它吗?随意编辑并提交拉取请求!
我们的文档工程位于(https://github.com/WeBankFinTech/WeEvent-docs)。会自动生成最新文档到(https://weeventdoc.readthedocs.io/zh_CN/latest/)。你看到一个错字或其他方法来改善它吗?欢迎提交PR。

### 提供帮助
#### 提供帮助

可以做的最简单的事情,就是帮助我们推动发展,并对我们的进展产生影响,帮助、支持在WeEvent中遇到困难的人。

你可以在这里回复 [issues on Github](https://github.com/WeBankFinTech/WeEvent/issues)

### 测试
#### 测试

我们的目标是(接近)100%测试覆盖率,因此请确保您的测试尽可能覆盖多的代码。


再次感谢您成为WeEvent社区的贡献者 :tada:!

Cheers

53 changes: 53 additions & 0 deletions README-en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[中文](README.md) | [English](README-en.md)

![image](https://github.com/WeBankFinTech/WeEvent-docs/blob/master/docs/image/weevent-logo.png)

[![CodeFactor](https://www.codefactor.io/repository/github/webankfintech/weevent/badge)](https://www.codefactor.io/repository/github/webankfintech/weevent)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d2141e952d84a47b0a615e51702bf6f)](https://www.codacy.com/app/WeEventAdmin/WeEvent?utm_source=github.com&utm_medium=referral&utm_content=WeBankFinTech/WeEvent&utm_campaign=Badge_Grade)
[![Build Status](https://travis-ci.com/WeBankFinTech/WeEvent.svg?branch=master)](https://travis-ci.com/WeBankFinTech/WeEvent)
[![Latest release](https://img.shields.io/github/release/WeBankFinTech/WeEvent.svg)](https://github.com/WeBankFinTech/WeEvent/releases/latest)
[![Maven Central](https://img.shields.io/maven-central/v/com.webank.weevent/weevent-client.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.webank.weevent%22%20AND%20a:%weevent-client%22)
[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://weeventdoc.readthedocs.io/zh_CN/latest/protocal/index.html)
[![Documentation Status](https://readthedocs.org/projects/weeventdoc/badge/?version=latest)](https://weeventdoc.readthedocs.io/zh_CN/latest)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

## What's WeEvent?

WeEvent is a distributed event-driven architecture that implements trustworthy, reliable and efficient cross-institutional and cross-platform event notification mechanism.

WeEvent is an open source architecture developed by WeBank for peer-to-peer cooperation, smart collaboration and value sharing in the Collaborative Business Model. Aiming at higher efficiency in cross-institutional cooperation with lower costs, it connects different platforms such like applications, IOTs, cloud services and private services via cross-institutional and cross-platform event notification and processing without changing the existing programming language and network interface protocol.

[WeEvent Official Site](http://fintech.webank.com/weevent).

## Getting Start
We can quick install WeEvent in 3 different ways:[Docker image](https://hub.docker.com/r/weevent/), [Bash Shell](https://weeventdoc.readthedocs.io/zh_CN/latest/install/quickinstall.html), [Advanced](https://weeventdoc.readthedocs.io/zh_CN/latest/install/module/index.html).
### Docker image
```shell
$ docker pull weevent/weevent:1.0.0; docker run -d -p 8080:8080 weevent/weevent:1.0.0 /root/run.sh
```

### Bash shell
[Download](https://weeventdoc.readthedocs.io/zh_CN/latest/install/download.html) and unzip the install package, like weevent-1.0.0.tar.gz. And then execute the install shell.
```shell
$ ./install-all.sh -p /usr/local/weevent/
```

### Tutorials
There are some base usecase showed via browser,like [Publish Event](http://localhost:8080/weevent/rest/publish?topic=test&content=helloevent).
For more examples, see the [WeEvent tutorials](https://weeventdoc.readthedocs.io/zh_CN/latest/protocal/restful.html).

## User’s Guide
[WeEvent online documents](https://weeventdoc.readthedocs.io/latest).

## Contribution
* Develop environment
git, gradle 4.10, java 1.8, nodejs 10.16, prefer IntelliJ IDEA.
* [WeEvent roadmap](https://github.com/WeBankFinTech/WeEvent/wiki/Project-RoadMap)
* [Git workflow](https://github.com/WeBankFinTech/WeEvent/wiki/Project-WorkFlow)

WeEvent love contributor!Please read the [CONTRIBUTING.md](https://github.com/WeBankFinTech/WeEvent/blob/master/CONTRIBUTING.md), and then submit a pull request.

Thank you!

## Community
* Contacts:weevent@webank.com
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[中文](README.md) | [English](README-en.md)

![image](https://github.com/WeBankFinTech/WeEvent-docs/blob/master/docs/image/weevent-logo.png)

[![CodeFactor](https://www.codefactor.io/repository/github/webankfintech/weevent/badge)](https://www.codefactor.io/repository/github/webankfintech/weevent)
Expand All @@ -13,37 +15,37 @@
WeEvent是一套分布式事件驱动架构,实现了可信、可靠、高效的跨机构、跨平台事件通知机制。

WeEvent由微众银行自主研发并完全开源,秉承分布式商业模式中对等合作、智能协同、价值共享的设计理念,致力于提升机构间合作效率,降低合作成本,同时打通应用程序、物联网、云服务和私有服务等不同平台,最终在不改变已有商业系统的开发语言、接入协议的情况下,做到跨机构、跨平台的事件通知与处理。
[WeEvent官网](http://fintech.webank.com/weevent)
[WeEvent官网](http://fintech.webank.com/weevent)

## 快速入门
支持[Docker镜像](https://hub.docker.com/r/weevent/)[Bash一键脚本](https://weeventdoc.readthedocs.io/zh_CN/latest/install/quickinstall.html)[普通安装](https://weeventdoc.readthedocs.io/zh_CN/latest/install/module/index.html)三种安装方式
#### Docker镜像安装
```
WeEvent支持三种安装方式:[Docker镜像](https://hub.docker.com/r/weevent/)[Bash一键脚本](https://weeventdoc.readthedocs.io/zh_CN/latest/install/quickinstall.html)[普通安装](https://weeventdoc.readthedocs.io/zh_CN/latest/install/module/index.html)
### Docker镜像安装
```shell
$ docker pull weevent/weevent:1.0.0; docker run -d -p 8080:8080 weevent/weevent:1.0.0 /root/run.sh
```

#### Bash一键安装
下载并且解压安装包,如weevent-1.0.0.tar.gz。在解压目录中执行安装脚本。
```
### Bash一键安装
[下载](https://weeventdoc.readthedocs.io/zh_CN/latest/install/download.html)并且解压安装包,如weevent-1.0.0.tar.gz。在解压目录中执行安装脚本。
```shell
$ ./install-all.sh -p /usr/local/weevent/
```

#### 功能体验
### 功能体验
通过浏览器即可体验事件发布等基本功能,如[发布事件](http://localhost:8080/weevent/rest/publish?topic=test&content=helloevent)
更多功能,请参见[WeEvent接入](https://weeventdoc.readthedocs.io/zh_CN/latest/protocal/restful.html)

## 用户文档
[WeEvent在线文档](https://weeventdoc.readthedocs.io/zh_CN/latest)

## 项目贡献
- 开发环境
git,gradle 4.10,java 1.8,nodejs 10.16,推荐使用IDEA
- [项目计划](https://github.com/WeBankFinTech/WeEvent/wiki/Project-RoadMap)
- [代码提交](https://github.com/WeBankFinTech/WeEvent/wiki/Project-WorkFlow)
* 开发环境
git,gradle 4.10,java 1.8,nodejs 10.16,推荐使用IntelliJ IDEA
* [项目计划](https://github.com/WeBankFinTech/WeEvent/wiki/Project-RoadMap)
* [代码提交](https://github.com/WeBankFinTech/WeEvent/wiki/Project-WorkFlow)

WeEvent爱贡献者!请阅读我们的[贡献文档](https://github.com/WeBankFinTech/WeEvent/blob/master/CONTRIBUTING.md),了解如何贡献代码,并提交你的贡献。
WeEvent爱贡献者!请阅读[贡献文档](https://github.com/WeBankFinTech/WeEvent/blob/master/CONTRIBUTING.md),了解如何贡献代码,并提交你的贡献。

希望在您的帮助下WeEvent继续前进。

## 社区
- 联系我们:weevent@webank.com
* 联系我们:weevent@webank.com

0 comments on commit 5e6b5d8

Please sign in to comment.