From 6ef1b5e14c0380259b6786379408ba6a21525c0a Mon Sep 17 00:00:00 2001
From: kevin <wanjunfeng@gmail.com>
Date: Fri, 14 Aug 2020 15:31:10 +0800
Subject: [PATCH] update doc

---
 doc/goctl.md | 37 ++++++++++++++++++++++---------------
 readme.md    | 16 ++++++++++------
 2 files changed, 32 insertions(+), 21 deletions(-)

diff --git a/doc/goctl.md b/doc/goctl.md
index b8eea01a..81840576 100644
--- a/doc/goctl.md
+++ b/doc/goctl.md
@@ -3,8 +3,8 @@
 ## goctl用途
 * 定义api请求
 * 根据定义的api自动生成golang(后端), java(iOS & Android), typescript(web & 晓程序)，dart(flutter)
-* 生成MySQL CURD (https://goctl.xiaoheiban.cn)
-*  生成MongoDB CURD (https://goctl.xiaoheiban.cn)
+* 生成MySQL CURD+Cache
+*  生成MongoDB CURD+Cache
 
 ## goctl使用说明
 #### goctl参数说明
@@ -179,23 +179,31 @@ service user-api {
   * 在定义的get/post/put/delete等请求的handler和logic里增加处理业务逻辑的代码
 
 #### 根据定义好的api文件生成java代码
-	`goctl api java -api user/user.api -dir ./src`
+```shell
+goctl api java -api user/user.api -dir ./src
+```
 
 #### 根据定义好的api文件生成typescript代码
-	`goctl api ts -api user/user.api -dir ./src -webapi ***`
-	
-	ts需要指定webapi所在目录
+```shell
+goctl api ts -api user/user.api -dir ./src -webapi ***
+
+ts需要指定webapi所在目录
+```
 
 #### 根据定义好的api文件生成Dart代码
-	`goctl api dart -api user/user.api -dir ./src`
+```shell
+goctl api dart -api user/user.api -dir ./src
+```
 
 ## 根据定义好的简单go文件生成mongo代码文件(仅限golang使用)  
-    `goctl model mongo -src {{yourDir}}/xiao/service/xhb/user/model/usermodel.go -cache yes`
-    
-    -src需要提供简单的usermodel.go文件，里面只需要提供一个结构体即可
-    -cache 控制是否需要缓存 yes=需要 no=不需要
-    src 示例代码如下
-  ```
+```shell
+goctl model mongo -src {{yourDir}}/xiao/service/xhb/user/model/usermodel.go -cache yes
+
+-src需要提供简单的usermodel.go文件，里面只需要提供一个结构体即可
+-cache 控制是否需要缓存 yes=需要 no=不需要
+src 示例代码如下
+```
+  ```go
 package model
     
 type User struct {
@@ -261,5 +269,4 @@ type User struct {
     │   └── test.go [强制覆盖更新]
     └── test.proto
   ```
-  - 注意 ：目前rpc目录生成的proto文件暂不支持import外部proto文件   
-* 如有不理解的地方，随时问Kim/Kevin
\ No newline at end of file
+  - 注意 ：目前rpc目录生成的proto文件暂不支持import外部proto文件   
\ No newline at end of file
diff --git a/readme.md b/readme.md
index f9d9b61c..b6d042e6 100644
--- a/readme.md
+++ b/readme.md
@@ -149,18 +149,18 @@ go-zero是一个集成了各种工程实践的包含web和rpc框架，有如下
 ```shell
    cd greet
    go run greet.go -f etc/greet-api.json
-   ```
-   
+```
+
 默认侦听在8888端口（可以在配置文件里修改），可以通过curl请求：
-   
+
 ```shell
    ➜  go-zero git:(master) curl -w "\ncode: %{http_code}\n" http://localhost:8888/greet/from/kevin
    {"code":0}
    code: 200
-   ```
-   
+```
+
 编写业务代码：
-   
+
 * 可以在servicecontext.go里面传递依赖给logic，比如mysql, redis等
    * 在api定义的get/post/put/delete等请求对应的logic里增加业务处理逻辑
    
@@ -172,6 +172,10 @@ go-zero是一个集成了各种工程实践的包含web和rpc框架，有如下
    ...
    ```
 
+## 8. 文档
+
+​	* [goctl使用帮助](doc/goctl.md)
+
 ### 微信交流群
 
 添加我的微信：kevwan，请注明go-zero，我拉进go-zero社区群🤝