Merge pull request #1 from meshplus/chore/update-readme

chore(readme): update readme
meshplus · Mar 30, 2020 · b274054 · b274054
2 parents 72ce9ae + a51c224
commit b274054
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 41 deletions.
diff --git a/Makefile b/Makefile
@@ -45,6 +45,9 @@ test-cover:
 packr:
 	cd internal/repo && packr
 
+prepare:
+	cd scripts && bash prepare.sh
+
 ## make install: Go install the project (hpc)
 install: packr
 	$(GO) install -ldflags '${LDFLAGS}' ./cmd/${APP_NAME}
@@ -56,7 +59,7 @@ docker-build: packr
 
 ## make build-linux: Go build linux executable file
 build-linux:
-	cd scripts && sh cross_compile.sh linux-amd64 ${CURRENT_PATH}
+	cd scripts && bash cross_compile.sh linux-amd64 ${CURRENT_PATH}
 
 ## make linter: Run golanci-lint
 linter:

diff --git a/README.md b/README.md
@@ -5,33 +5,62 @@
 Using the follow command to install necessary tools.
 
 ```bash
-make init
+make prepare
 ```
 
-And then install bitxmesh using the follow command.
+And then install pier using the following command.
 
 ```bash
 make install
 ```
 
+## Initialization
+
+Using the follow command to initialize pier.
+```bash
+pier init
+```
+Default repo path is `~/.pier`. If you want to specify the repo path, you can use `--repo` flag.
+
+```bash
+pier init --repo=$HOME/.pier
+```
+
+After initializing pier, it will generate the follow directory:
+
+```
+~/.pier
+├── pier.toml
+├── key.json
+
+```
+
 ## Configuration
 
 ```toml
 title = "pier"
 
 [port]
-pprof = 44556
+pprof = 44555
 
 [log]
 level = "debug"
+dir = "logs"
+filename = "pier.log"
+report_caller = false
 
 [bitxhub]
 addr = "localhost:60011"
+validators = [
+      "0x000f1a7a08ccc48e5d30f80850cf1cf283aa3abd",
+      "0xe93b92f1da08f925bdee44e91e7768380ae83307",
+      "0xb18c8575e3284e79b92100025a31378feb8100d6",
+      "0x856E2B9A5FA82FD1B031D1FF6863864DBAC7995D",
+]
 
 [appchain]
-type = "fabric" 
-[appchain.fabric]
-  "addr" = "139.219.105.188:10053"
+plugin = "fabric-client-1.4.so"
+config = "fabric"
 ```
 
 `port.pprof`: the pprof server port
@@ -40,42 +69,12 @@ type = "fabric"
 
 `bitxhub.addr`: bitxhub grpc server port
 
-`appchain.type`: fabric only
+`bitxhub.validators`: bitxhub validator's addresses
 
-`appchain.validators`: appchain validators address
+`appchain.plugin`: relative path in pier repo of appchain plugin
 
-`appchain.fabric.addr`: fabric address
+`appchain.config`: relative path of appchain config directory
 
 ## Usage
 
-Using the follow command to initialize pier.
-```bash
-pier init
-```
-Default repo path is `~/.pier`. If you want to specify the repo path, you can use `--repo` flag.
-
-```bash
-pier init --repo=/Users/xcc/.pier_fabric
-```
-
-After initializing pier, it will generate the follow directory:
-
-```
-~/.pier
-├── pier.account
-├── pier.toml
-├── fabric
-│   ├── config_fab.yaml
-│   └── crypto-config
-└── plugins
-    ├── fabric-client-1.0.so
-    └── hpc-client.so
-```
-
-Depending on the type of appchain, you should write your config in the `pier.toml`.
-
-Next, launch your pier:
-
-```bash
-pier start
-```
+More details about usage is in [Pier handbook](https://github.com/meshplus/pier/wiki/Pier%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3)
diff --git a/go.sum b/go.sum
@@ -46,11 +46,13 @@ github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/me
 github.com/gobuffalo/envy v1.7.0/go.mod h1:n7DRkBerg/aorDM8kbduw5dN3oXGswK5liaSCx4T5NI=
 github.com/gobuffalo/envy v1.8.1 h1:RUr68liRvs0TS1D5qdW3mQv2SjAsu1QWMCx1tG4kDjs=
 github.com/gobuffalo/envy v1.8.1/go.mod h1:FurDp9+EDPE4aIUS3ZLyD+7/9fpx7YRt/ukY6jIHf0w=
+github.com/gobuffalo/logger v1.0.0 h1:xw9Ko9EcC5iAFprrjJ6oZco9UpzS5MQ4jAwghsLHdy4=
 github.com/gobuffalo/logger v1.0.0/go.mod h1:2zbswyIUa45I+c+FLXuWl9zSWEiVuthsk8ze5s8JvPs=
 github.com/gobuffalo/packd v0.3.0 h1:eMwymTkA1uXsqxS0Tpoop3Lc0u3kTfiMBE6nKtQU4g4=
 github.com/gobuffalo/packd v0.3.0/go.mod h1:zC7QkmNkYVGKPw4tHpBQ+ml7W/3tIebgeo1b36chA3Q=
 github.com/gobuffalo/packr v1.30.1 h1:hu1fuVR3fXEZR7rXNW3h8rqSML8EVAf6KNm0NKO/wKg=
 github.com/gobuffalo/packr v1.30.1/go.mod h1:ljMyFO2EcrnzsHsN99cvbq055Y9OhRrIaviy289eRuk=
+github.com/gobuffalo/packr/v2 v2.5.1 h1:TFOeY2VoGamPjQLiNDT3mn//ytzk236VMO2j7iHxJR4=
 github.com/gobuffalo/packr/v2 v2.5.1/go.mod h1:8f9c96ITobJlPzI44jj+4tHnEKNt0xXWSVlXRN9X1Iw=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4=
@@ -81,6 +83,7 @@ github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
+github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869 h1:IPJ3dvxmJ4uczJe5YQdrYB16oTJlGSC/OyZDqUk9xX4=
 github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869/go.mod h1:cJ6Cj7dQo+O6GJNiMx+Pa94qKj+TG8ONdKHgMNIyyag=
@@ -92,6 +95,7 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V
 github.com/karrick/godirwalk v1.10.12/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA=
 github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
 github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQLJ+jE2L00=
+github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/konsorten/go-windows-terminal-sequences v1.0.2 h1:DB17ag19krx9CFsz4o3enTrPXyIXCl+2iCXH/aMAp9s=
@@ -220,6 +224,7 @@ go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20190621222207-cc06ce4a13d4 h1:ydJNl0ENAG67pFbB+9tfhiL2pYqLhfoaZFw/cjLhY4A=
 golang.org/x/crypto v0.0.0-20190621222207-cc06ce4a13d4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=

diff --git a/scripts/prepare.sh b/scripts/prepare.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+printf "1. Set go proxy\n"
+export GO111MODULE=on
+go env -w GOPROXY=https://goproxy.cn,direct
+
+printf "2. Install packr\n"
+go get -u github.com/gobuffalo/packr/packr
+
+printf "3. Install golangci-lint\n"
+go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.18.0