From 924245151f5febee06e9d057fcd76e48013e17de Mon Sep 17 00:00:00 2001 From: henrylee2cn Date: Thu, 22 Mar 2018 19:12:50 +0800 Subject: [PATCH] optimize readme --- README.md | 16 ++++++++-------- README_ZH.md | 16 ++++++++-------- ant/README.md | 8 ++++---- gateway/README.md | 6 +++--- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 43c78dd..30f995d 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 @@ -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: @@ -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!
When the project is completed, it should be removed! -### 3.3 Run project +### Run project `ant run` command help: @@ -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 @@ -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 diff --git a/README_ZH.md b/README_ZH.md index 2041aa8..b812912 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -3,7 +3,7 @@ Ants 是一套基于 [TP-Micro](https://github.com/henrylee2cn/tp-micro) 和 [Teleport](https://github.com/henrylee2cn/teleport) 的、高可用的微服务平台解决方案。 -## 1 安装 +## 安装 ``` go version ≥ 1.9 @@ -13,7 +13,7 @@ go version ≥ 1.9 go get -u -f -d github.com/xiaoenai/ants/... ``` -## 2 特性 +## 特性 - 支持服务自动发现 - 支持自定义服务链接选择器 @@ -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: @@ -138,7 +138,7 @@ type StatArgs struct { - 在自动生成的文件的文件名中增加 `.gen` 后缀进行标记 - `tmp_code.gen.go` 是为了通过编译而生成的临时文件,项目完成后应该移除它 -### 3.3 热编译运行 +### 热编译运行 `ant run` 命令帮助: @@ -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 @@ -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) 协议发布 diff --git a/ant/README.md b/ant/README.md index 70738fc..1943231 100644 --- a/ant/README.md +++ b/ant/README.md @@ -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: @@ -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!
When the project is completed, it should be removed! -## 4 Run project +## Run project `ant run` command help: diff --git a/gateway/README.md b/gateway/README.md index 7655396..188d5f7 100644 --- a/gateway/README.md +++ b/gateway/README.md @@ -2,7 +2,7 @@ Package gateway is the main program for TCP and HTTP services. -## 1 Demo +## Demo ```go package main @@ -20,9 +20,9 @@ func main() { } ``` -## 2 Usage +## Usage -### 2.1 Authorization +### Authorization - HTTP short connection gateway * Optional authorization