add chinese readme & vscode gif

README.md

@@ -7,6 +7,8 @@
 [![codecov](https://codecov.io/gh/qiniu/goc/branch/master/graph/badge.svg)](https://codecov.io/gh/qiniu/goc)
 [![GoDoc](https://godoc.org/github.com/qiniu/goc?status.svg)](https://godoc.org/github.com/qiniu/goc)
 
+[中文页](README_zh.md) |
+
 goc is a comprehensive coverage testing system for The Go Programming Language, especially for some complex scenarios, like system testing code coverage collection and
 accurate testing.
 
@@ -17,12 +19,12 @@ Enjoy, Have Fun!
 
 Download the latest version from [Github Releases](https://github.com/qiniu/goc/releases) page.
 
-For developing, you need install Go first (**version 1.13+ is required**).
+Goc supports both `GOPATH` project and `Go Modules` project with **Go 1.11+**. However, for developing goc, you need to install **Go 1.13+**.
 
 ## Examples
 You can use goc tool in many scenarios.
 
-### Code Coverage Collection for your Golang System Tests
+### Code Coverage Collection for Your Golang System Tests
 Goc can collect code coverages at runtime for your long-run golang applications. To do that, normally just need three steps:
 
 1. use `goc server` to start a service registry center:
@@ -47,11 +49,17 @@ Goc can collect code coverages at runtime for your long-run golang applications.
     ...   
     ```
 
+### Show Code Coverage Change at Runtime in Vscode
+
+We provide a vscode extension - [Goc Coverage](https://marketplace.visualstudio.com/items?itemName=lyyyuna.goc) which can show highlighted covered source code at runtime. 
+
+![Extension](docs/images/goc-vscode.gif)
+
 ## Tips
 
 1. To understand the execution details of goc tool, you can use the `--debug` flag. Also we appreciate if you can provide such logs when submitting a bug to us.
 
-2. By default, the covered service will listen a random port in order to communicate with the goc server. this may not be suitable in [docker](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose) or [kubernetes](https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service) environment since the port must be exposed explicitly in order to be accessible by others in such environment. For this kind of scenario, you can use `--agentport` flag to specific a fixed port when calling `goc build` or `goc install`.
+2. By default, the covered service will listen a random port in order to communicate with the goc server. This may not be suitable in [docker](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose) or [kubernetes](https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service) environment since the port must be exposed explicitly in order to be accessible by others in such environment. For this kind of scenario, you can use `--agentport` flag to specific a fixed port when calling `goc build` or `goc install`.
 
 3. To use a remote goc server, you can use `--center` flag to compile the target service with `goc build` or `goc install` command.
 
@@ -76,5 +84,5 @@ Thanks to all [contributors](https://github.com/qiniu/goc/graphs/contributors)!!
 ## License
 Goc is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/qiniu/goc/blob/master/LICENSE)
 
-## Join goc WeChat group
+## Join goc WeChat Group
 ![WeChat](docs/images/wechat.png)

README_zh.md

@@ -0,0 +1,92 @@
+# goc
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/qiniu/goc)](https://goreportcard.com/report/github.com/qiniu/goc)
+![](https://github.com/qiniu/goc/workflows/ut-check/badge.svg)
+![](https://github.com/qiniu/goc/workflows/style-check/badge.svg)
+![](https://github.com/qiniu/goc/workflows/e2e%20test/badge.svg)
+![Build Release](https://github.com/qiniu/goc/workflows/Build%20Release/badge.svg)
+[![codecov](https://codecov.io/gh/qiniu/goc/branch/master/graph/badge.svg)](https://codecov.io/gh/qiniu/goc)
+[![GoDoc](https://godoc.org/github.com/qiniu/goc?status.svg)](https://godoc.org/github.com/qiniu/goc)
+
+goc 是专为 Go 语言打造的一个综合覆盖率收集系统，尤其适合复杂的测试场景，比如系统测试时的代码覆盖率收集以及精准测试。
+
+希望你们喜欢～
+
+![Demo](docs/images/intro.gif)
+
+## 安装
+
+最新版本在该页面下载 [Github Releases](https://github.com/qiniu/goc/releases)。
+
+goc 同时支持 `GOPATH` 工程和 `Go Modules` 工程，且 Go 版本要求 **Go 1.11+**。如果想参与 goc 的开发，你必须使用 **Go 1.13+**。
+
+## 例子
+
+goc 有多种使用场景。
+
+### 在系统测试中收集代码覆盖率
+
+goc 可以实时收集长时运行的 golang 服务覆盖率。收集步骤只需要下面三步：
+
+1. 运行 `goc server` 命令启动一个服务注册中心：
+    ```
+    ➜  simple-go-server git:(master) ✗ goc server
+    ```
+2. 运行 `goc build` 命令编译目标服务，然后启动插过桩的二进制。下面以 [simple-go-server](https://github.com/CarlJi/simple-go-server) 工程为例：
+    ```
+    ➜  simple-go-server git:(master) ✗ goc build .
+    ... // omit logs
+    ➜  simple-go-server git:(master) ✗ ./simple-go-server  
+    ```
+3. 运行 `goc profile` 命令收集刚启动的 simple server 的代码覆盖率：
+    ```
+    ➜  simple-go-server git:(master) ✗ goc profile
+    mode: atomic
+    enricofoltran/simple-go-server/main.go:30.13,48.33 13 1
+    enricofoltran/simple-go-server/main.go:48.33,50.3 1 0
+    enricofoltran/simple-go-server/main.go:52.2,65.12 5 1
+    enricofoltran/simple-go-server/main.go:65.12,74.46 7 1
+    enricofoltran/simple-go-server/main.go:74.46,76.4 1 0
+    ...   
+    ```
+
+### Vscode 中实时展示覆盖率动态变化
+
+我们提供了一个 vscode 插件 - [Goc Coverage](https://marketplace.visualstudio.com/items?itemName=lyyyuna.goc)。该插件可以在运行时高亮覆盖过的代码。
+
+![Extension](docs/images/goc-vscode.gif)
+
+## Tips
+
+1. goc 命令加上 `--debug` 会打印详细的日志。我们建议在提交 bug 时附上详细日志。
+
+2. 默认情况下，插桩过的服务会监听在一个随机的端口，注册中心会通过这个端口与服务通信。然而，对于 [docker](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose) 和 [kubernetes](https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service) 容器化运行环境，对外暴露端口需在容器启动前指定。针对这种场景，你可以在 `goc build` 或 `goc install` 时使用 `--agentport` 来指定插桩过的服务监听在固定的端口。
+
+3. 如果注册中心不在本机，你可以在 `goc build` 或 `goc install` 编译目标服务时使用 `--center` 指定远端注册中心地址。
+
+4. 目前覆盖率数据存储在插过桩的服务测，如果某个服务中途需要重启，那么其覆盖率数据在重启后会丢失。针对这个场景，你可以通过以下步骤解决：
+
+    1. 在重启前，通过 `goc profile -o a.cov` 命令收集一次覆盖率
+    2. 测试结束后，通过 `goc profile -o b.cov` 命令再收集一次覆盖率
+    3. 通过 `goc merge a.cov b.cov -o merge.cov` 命令合并两次的覆盖率
+
+## RoadMap
+
+- [x] 支持系统测试中收集代码覆盖率
+- [x] 支持运行时对被测服务代码覆盖率计数器清零
+- [x] 支持精准测试
+- [ ] 支持基于 Pull Request 的增量代码覆盖率报告
+- [ ] 优化插桩计数器带来的性能损耗
+
+## Contributing
+
+我们欢迎各种形式的贡献，包括提交 bug、提新需求、优化文档和改进 UI 等等。
+
+感谢所有的[贡献者](https://github.com/qiniu/goc/graphs/contributors)!!
+
+## License
+
+Goc is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/qiniu/goc/blob/master/LICENSE)
+
+## 加入微信群聊
+![WeChat](docs/images/wechat.png)