release 0.4.0

README.md

@@ -1,37 +1,43 @@
-# ypk-deploy-tool
+# 使用说明
+1） 在`build.gradle`中进行配置。
+ ```groovy
+ buildscript {
+    repositories {
+        mavenLocal()
+        mavenCentral()
+    }
+    dependencies {
+        classpath "org.bdware.bdcontract:ypk-deploy-tool:0.3.0"
+    }
+}
+//....
+task deploy(dependsOn: ["xxx"]) {
+    doLast {
+        org.bdware.ypkdeploy.HTTPTool.batchRun("./xxx/deployconfig.json", true)
+    }
+}
+```
+2） 配置`./xxx/deployconfig.json`文件。
+参数说明：
 
-#### 介绍
-ypk-deploy-tool
+`host`为运行了bdagent的服务端的ip
 
-#### 软件架构
-软件架构说明
+`agentPort`为端口。
 
+`privateKey/publicKey`为有部署权限的一组SM2KeyPair
 
-#### 安装教程
+`ypkPath`是待部署的ypk路径。
 
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### 使用说明
-
-1.  xxxx
-2.  xxxx
-3.  xxxx
-
-#### 参与贡献
-
-1.  Fork 本仓库
-2.  新建 Feat_xxx 分支
-3.  提交代码
-4.  新建 Pull Request
-
-
-#### 特技
-
-1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
-4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
-5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
-6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+`deployconfig.json`配置示例：
+```json
+{
+  "host": "192.168.x.x",
+  "agentPort": 18000,
+  "privateKey": "5895c18430dd...",
+  "publicKey": "04d1924329f72ced14...",
+  "ypkPath":  "/path/to/todeploy.ypk",
+  "killBeforeStart": "ContractName",
+  "createParam": {
+  }
+}
+```