writer close

[bytom/vapor.git] / README.md

diff --git a/README.md b/README.md
index 4eb6322..52870ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,14 +32,13 @@ $ make install
 Firstly, you need initialize node:
 
 ```
-$ vapord 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`:
-
-```
-$ vapord init --chain_id=vapor --home $HOME/bytom/vapor
-```
+The default vapor data path (on the host) is:
++ Mac: `~/Library/Application Support/Vapor`
++ Linux: `~/.vapor`
++ Windows: `%APPDATA%\Vapor`
 
 Then, start your node:
 
@@ -68,8 +67,6 @@ vapor data directory has three config files:
 - `federation.json`
 - `node_key.txt`
 
-Then you can use vapord and bytomcli following [Bytom Wiki](https://github.com/Bytom/bytom/wiki/Command-Line-Options).
-
 Use `exit` to exit Docker's iterative mode.
 
 ### Daemon mode
@@ -95,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:
@@ -110,6 +107,20 @@ 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)
+
 ## License
 
 [AGPL v3](./LICENSE)