From 49d09b65bbff124aab16b1364e5a2ad52391e33e Mon Sep 17 00:00:00 2001 From: Andrew Nguyen Date: Tue, 19 Feb 2019 11:24:44 -0500 Subject: [PATCH] Moved all defaults and examples to new line in readme --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ab6e78e1e..9ca190efa 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,14 @@ The Pocket Core application will allow anyone to spin up a Pocket Network full n To run the Pocket Core binary you can use the following flags alongside the `pocket-core` executable: ```` -cfile string - specifies the filepath for chains.json (default "[datadir]/chains.json") + specifies the filepath for chains.json + (default "[datadir]/chains.json") -clientrpc - whether or not to start the rpc server (default true) + whether or not to start the rpc server + (default true) -clientrpcport string - specified port to run client rpc (default "8080") + specified port to run client rpc + (default "8080") -datadirectory string setup a custom location for the datadirectory (default: `%APPDATA%\Pocket` for Windows, `~/.pocket` for Linux, `~/Library/Pocket` for Mac) @@ -68,29 +71,40 @@ To run the Pocket Core binary you can use the following flags alongside the `poc specifies the database endpoint for the centralized dispatcher (default "dynamodb.us-east-2.amazonaws.com") -dbtable string - specifies the database tablename for the centralized dispatcher (default "dispatchPeers") + specifies the database tablename for the centralized dispatcher + (default "dispatchPeers") -dfile string - specifies the filepath for developer_whitelist.json (default "[datadir]/developer_whitelist.json") + specifies the filepath for developer_whitelist.json + (default "[datadir]/developer_whitelist.json") -discport string - specifies the client port of the centralized dispatcher (default "8080") + specifies the client port of the centralized dispatcher + (default "8080") -disip string - specifies the address of the centralized dispatcher (default "localhost") + specifies the address of the centralized dispatcher + (default "localhost") -dismode int - specifies the mode by which the dispatcher is operating (0) Normal, (1) Migrate, (2) Deprecated + specifies the mode by which the dispatcher is operating + (0) Normal, (1) Migrate, (2) Deprecated -dispatch specifies if this node is operating as a dispatcher -disrport string - specifies the relay port of the centralized dispatcher (default "8081") + specifies the relay port of the centralized dispatcher + (default "8081") -gid string - set the selfNode.GID for pocket core mvp (default "GID1") + set the selfNode.GID for pocket core mvp + (default "GID1") -pfile string - specifies the filepath for peers.json (default "[datadir]/peers.json") + specifies the filepath for peers.json + (default "[datadir]/peers.json") -relayrpc - whether or not to start the rpc server (default true) + whether or not to start the rpc server + (default true) -relayrpcport string - specified port to run relay rpc (default "8081") + specified port to run relay rpc + (default "8081") -sfile string - specifies the filepath for service_whitelist.json (default "[datadir]/service_whitelist.json") + specifies the filepath for service_whitelist.json + (default "[datadir]/service_whitelist.json") ````

How to test