Skip to content

Commit

Permalink
optimize readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andeya committed Mar 22, 2018
1 parent 9c58bd6 commit 9242451
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Ants is a highly available micro service platform based on [TP-Micro](https://gi
[简体中文](https://github.com/xiaoenai/ants/blob/master/README_ZH.md)


## 1 Install
## Install


```
Expand All @@ -17,7 +17,7 @@ go version ≥ 1.9
go get -u -f -d github.com/xiaoenai/ants/...
```

## 2 Feature
## Feature

- Support auto service-discovery
- Supports custom service linker
Expand All @@ -36,16 +36,16 @@ go get -u -f -d github.com/xiaoenai/ants/...
- Client support automatically redials after disconnection


## 3 Project Management
## Project Management

### 3.1 Install Ant Command
### Install Ant Command

```sh
cd $GOPATH/src/github.com/xiaoenai/ants/ant
go install
```

### 3.2 Generate project
### Generate project

`ant gen` command help:

Expand Down Expand Up @@ -142,7 +142,7 @@ Desc:
- add `.gen` suffix to the file name of the automatically generated file
- `tmp_code.gen.go` is temporary code used to ensure successful compilation!<br>When the project is completed, it should be removed!

### 3.3 Run project
### Run project

`ant run` command help:

Expand All @@ -164,7 +164,7 @@ example: `ant run -x .yaml -p myant` or `ant run`

[More Ant Command](https://github.com/xiaoenai/ants/tree/master/ant)

## 4 Demo
## Demo


- server
Expand Down Expand Up @@ -247,6 +247,6 @@ func main() {

[More](https://github.com/henrylee2cn/tp-micro/tree/master/samples)

## 5 License
## License

Ants is under Apache v2 License. See the [LICENSE](https://github.com/xiaoenai/ants/raw/master/LICENSE) file for the full license text
16 changes: 8 additions & 8 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Ants 是一套基于 [TP-Micro](https://github.com/henrylee2cn/tp-micro)[Teleport](https://github.com/henrylee2cn/teleport) 的、高可用的微服务平台解决方案。

## 1 安装
## 安装

```
go version ≥ 1.9
Expand All @@ -13,7 +13,7 @@ go version ≥ 1.9
go get -u -f -d github.com/xiaoenai/ants/...
```

## 2 特性
## 特性

- 支持服务自动发现
- 支持自定义服务链接选择器
Expand All @@ -31,16 +31,16 @@ go get -u -f -d github.com/xiaoenai/ants/...
- 支持的网络类型:`tcp``tcp4``tcp6``unix``unixpacket`
- 客户端支持断线后自动重连

## 3 项目管理
## 项目管理

### 3.1 安装ant命令行
### 安装ant命令行

```sh
cd $GOPATH/src/github.com/xiaoenai/ants/ant
go install
```

### 3.2 生成项目
### 生成项目

`ant gen` command help:

Expand Down Expand Up @@ -138,7 +138,7 @@ type StatArgs struct {
- 在自动生成的文件的文件名中增加 `.gen` 后缀进行标记
- `tmp_code.gen.go` 是为了通过编译而生成的临时文件,项目完成后应该移除它

### 3.3 热编译运行
### 热编译运行

`ant run` 命令帮助:

Expand All @@ -160,7 +160,7 @@ example: `ant run -x .yaml -p myant` or `ant run`

[更多 Ant 命令](https://github.com/xiaoenai/ants/tree/master/ant)

## 4 Ant项目示例
## Ant项目示例

- server

Expand Down Expand Up @@ -242,6 +242,6 @@ func main() {

[更多](https://github.com/henrylee2cn/tp-micro/tree/master/samples)

## 5 开源协议
## 开源协议

Ant 项目采用商业应用友好的 [Apache2.0](https://github.com/xiaoenai/ant/raw/master/LICENSE) 协议发布
8 changes: 4 additions & 4 deletions ant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

A deployment tools for [TP-Micro](https://github.com/henrylee2cn/tp-micro) micro service framework.

## 1 Feature
## Feature

- Quickly create a ant project
- Run ant project with hot compilation

## 2 Install
## Install

```sh
go install
```

## 3 Generate project
## Generate project

`ant gen` command help:

Expand Down Expand Up @@ -110,7 +110,7 @@ Desc:
- add `.gen` suffix to the file name of the automatically generated file
- `tmp_code.gen.go` is temporary code used to ensure successful compilation!<br>When the project is completed, it should be removed!

## 4 Run project
## Run project

`ant run` command help:

Expand Down
6 changes: 3 additions & 3 deletions gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Package gateway is the main program for TCP and HTTP services.

## 1 Demo
## Demo

```go
package main
Expand All @@ -20,9 +20,9 @@ func main() {
}
```

## 2 Usage
## Usage

### 2.1 Authorization
### Authorization

- HTTP short connection gateway
* Optional authorization
Expand Down

0 comments on commit 9242451

Please sign in to comment.