fix log

[bytom/vapor.git] / README.md

diff --git a/README.md b/README.md
index 19b455c..55fd282 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Vapor
 
 ## Requirements
 
-- [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
+- [Go](https://golang.org/doc/install) version 1.11 or higher, with `$GOPATH` set to your preferred directory
 
 ## Get source code
 
@@ -27,73 +27,23 @@ $ cd $GOPATH/src/github.com/vapor
 $ make install
 ```
 
-## Run
+## Run Directly
 
 Firstly, you need initialize node:
 
 ```
-$ bytomd init --chain_id=vapor --home <vapor-data-path>
+$ vapord init --chain_id=mainnet --home <vapor-data-path>
 ```
 
-For example, you can store vapor data in `$HOME/bytom/vapor`:
-
-```
-$ bytomd init --chain_id=vapor --home $HOME/bytom/vapor
-```
-
-And some files in `<vapor-data-path>`:
-
-```
-$ cd <vapor-data-path>
-$ tree -L 1
-.
-├── LOCK
-├── config.toml
-├── data
-├── federation.json
-├── keystore
-└── node_key.txt
-```
-
-`config.toml` save vapor network info, like:
-
-```
-$ cat config.toml
-# This is a TOML config file.
-# For more information, see https://github.com/toml-lang/toml
-fast_sync = true
-db_backend = "leveldb"
-api_addr = "0.0.0.0:9889"
-moniker = ""
-chain_id = "vapor"
-[p2p]
-laddr = "tcp://0.0.0.0:56659"
-seeds = "52.83.133.152:56659"
-```
-
-`federation.json` save relayed node xpub, like:
-
-```
-$ cat federation.json
-{
-  "xpubs": [
-    "50ef22b3a3fca7bc08916187cc9ec2f4005c9c6b1353aa1decbd4be3f3bb0fbe1967589f0d9dec13a388c0412002d2c267bdf3b920864e1ddc50581be5604ce1"
-  ],
-  "quorum": 1
-}
-```
+The default vapor data path (on the host) is:
++ Mac: `~/Library/Application Support/Vapor`
++ Linux: `~/.vapor`
++ Windows: `%APPDATA%\Vapor`
 
 Then, start your node:
 
 ```
-$ bytomd node --home <vapor-data-path>
-```
-
-Solonet mode:
-
-```
-$ bytomd init --chain_id=solonet --home <vapor-data-path>
-$ bytomd node --home <vapor-data-path>
+$ vapord node --home <vapor-data-path>
 ```
 
 ## Running in Docker
@@ -117,8 +67,6 @@ vapor data directory has three config files:
 - `federation.json`
 - `node_key.txt`
 
-Then you can use bytomd and bytomcli following [Bytom Wiki](https://github.com/Bytom/bytom/wiki/Command-Line-Options).
-
 Use `exit` to exit Docker's iterative mode.
 
 ### Daemon mode
@@ -126,7 +74,7 @@ Use `exit` to exit Docker's iterative mode.
 For example,
 
 ```bash
-$ docker run -d --net=host -v <vapor/data/directory/on/host/machine>:/root/.vapor vapor:latest bytomd node --web.closed --auth.disable
+$ docker run -d --net=host -v <vapor/data/directory/on/host/machine>:/root/.vapor vapor:latest vapord node --web.closed --auth.disable
 ```
 
 To list the running containners and check their container id, image, corresponding command, created time, status, name and ports being used:
@@ -144,7 +92,7 @@ $ docker ps
 To execute a command inside a containner, for example:
 
 ```
-$ docker exec -it <containerId> bytomcli create-access-token <tokenId>
+$ docker exec -it <containerId> vaporcli create-access-token <tokenId>
 ```
 
 To stop a running containner:
@@ -159,6 +107,25 @@ To remove a containner:
 $ docker rm <containerId>
 ```
 
+### Reward distribution tool
+
+After the supernode and alternative node receive the reward from the node, they will allocate the reward
+
+according to the interest rate. 
+
+The reward calculation rules: 
+
+ calculate the reward (consensus reward * interest rate * voting weight) according to the weight of votes
+
+cast in consensus around, and choose how many rounds of consensus to allocate the reward flexibly.
+
+[Tool usage details](./cmd/votereward/README.md)
+
+
+### Merger utxo
+UTXO has been merged to solve the problem that too much UTXO input causes a failed send transaction to fail. 
+[details](./cmd/utxomerge/README.md)
+
 ## License
 
 [AGPL v3](./LICENSE)