Improve docs

gogradle · Apr 18, 2017 · 539af57 · 539af57
1 parent e7cc2d4
commit 539af57
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ Gogradle is a gradle plugin which provides support for building golang.
 - Support shadowsocks proxy 
 - IDE support (IntelliJIDEA/Gogland/Webstorm/PhpStorm/PyCharm/RubyMine/CLion/Vim)
 - Test and coverage report generation
-- Incremental build (experimental)
+- Incremental build 
 
 ## Highlight
 

diff --git a/README_CN.md b/README_CN.md
@@ -46,7 +46,7 @@ Gogradle是一个提供Go语言构建支持的Gradle插件。
 - Shadowsocks支持
 - IDE支持（IntelliJIDEA/WebStorm/PhpStorm/PyCharm/RubyMine/CLion/Gogland/Vim）
 - 测试和覆盖率报告生成
-- 增量构建（实验性功能）
+- 增量构建
 
 ## 优势
 

diff --git a/docs/dependency-management-cn.md b/docs/dependency-management-cn.md
@@ -39,6 +39,12 @@ dependencies {
 }
 ```
 
+默认情况下，如果你的声明没有指定commit的话，Gogradle就不会对本地缓存中的仓库执行`git pull`或者`hg update -u`。若期望如此，请使用`--refresh-dependencies`：
+
+```
+gradlew goBuild --refresh-dependencies
+```
+
 依赖声明支持[语义化版本](http://semver.org/)。在Git中，"版本"即Git的tag。不过，考虑到构建的第一要务是保证稳定，Gogradle并不推荐使用它们。
 
 ```groovy

diff --git a/docs/dependency-management.md b/docs/dependency-management.md
@@ -38,6 +38,13 @@ dependencies {
 }
 ```
 
+By default, if you don't specify a commit, Gogradle won't do `git pull` or `hg update -u`  in local repository. You can use `--refresh-dependencies` to force Gogradle to do so:
+
+```
+gradlew goBuild --refresh-dependencies
+``` 
+
+
 [SemVersion](http://semver.org/) is supported in dependency declaration. In Git, a "version" is just a tag. Gogradle doesn't recommend to use SemVersion since it may break reproducibility of build.
 
 ```groovy