update readme

ExchangeUnion · Aug 11, 2018 · 789fccd · 789fccd
1 parent fd19c67
commit 789fccd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 12 deletions.
diff --git a/bin/xud b/bin/xud
@@ -17,6 +17,10 @@ const { argv } = require('yargs')
       describe: 'Hostname for SQL database',
       type: 'string',
     },
+    'db.password': {
+      describe: 'Password for SQL database',
+      type: 'string',
+    },
     'db.port': {
       describe: 'Port for SQL database',
       type: 'number',

diff --git a/instructions-for-devs.md b/instructions-for-devs.md
@@ -54,13 +54,15 @@ Options:
   --xudir, -x         Data directory for xud                            [string]
   --db.database       SQL database name                                 [string]
   --db.host           Hostname for SQL database                         [string]
+  --db.password       Password for SQL database                         [string]
   --db.port           Port for SQL database                             [number]
   --db.username       User for SQL database                             [string]
   --lnd.certpath      Path to the SSL certificate for lnd               [string]
   --lnd.disable       Disable lnd integration                          [boolean]
   --lnd.host          Host of the lnd gRPC interface                    [string]
   --lnd.macaroonpath  Path of the admin macaroon for lnd                [string]
   --lnd.port          Port of the lnd gRPC interface                    [number]
+  --p2p.addresses     String array of reachable addresses                [array]
   --p2p.listen        Listen for incoming peers                        [boolean]
   --p2p.port, -p      Port to listen for incoming peers                 [number]
   --raiden.disable    Disable raiden integration                       [boolean]
@@ -81,27 +83,27 @@ xucli <command>
 
 Commands:
   xucli cancelorder <pair_id> <order_id>    cancel an order
-  xucli connect <host> [port]               connect to an xu node
-  xucli disconnect <host> [port]            disconnect from an xu node
+  xucli connect <node_pub_key> <host>       connect to an xu node
+  [port]
+  xucli disconnect <node_pub_key>           disconnect from an xu node
   xucli executeSwap <identifier> <role>     execute an atomic swap
   <sending_amount> <sending_token>
   <receiving_amount> <receiving_token>
   xucli getinfo                             get general info from the xud node
-  xucli getorders [pair_id] [max_results]   get orders from the order book
+  xucli getorders <pair_id> [max_results]   get orders from the order book
   xucli getpairs                            get order book's available pairs
-  xucli placeorder <pair_id> <order_id>     place an order
-  <quantity> [price]
+  xucli listpeers                           list connected peers
+  xucli placeorder <pair_id> <order_id>     place an order, if price is 0 or
+  <quantity> [price]                        unspecified a market order is placed
   xucli shutdown                            gracefully shutdown the xud node
-  xucli subscribepeerorders                 subscribe to incoming peer orders
+  xucli subscribepeerorders                 subscribe to peer order events
   xucli subscribeswaps                      subscribe to executed swaps
 
 Options:
   --help          Show help                                            [boolean]
   --version       Show version number                                  [boolean]
   --rpc.port, -p  RPC service port                      [number] [default: 8886]
   --rpc.host, -h  RPC service hostname           [string] [default: "localhost"]
-
-
 ```
 
 Examples:
@@ -120,14 +122,14 @@ Examples:
 
 ```
 
-
 ## Configuration (optional)
 
-This *optional* configuration file uses [TOML](https://github.com/toml-lang/toml) and by default should be saved at  `~/.xud/xud.conf` on Linux or `AppData\Local\Xud\xud.conf` on Windows (run `xud` at least once for this folder to be created). Default settings which can be overridden are shown below.
+This *optional* configuration file uses [TOML](https://github.com/toml-lang/toml) and by default should be saved at  `~/.xud/xud.conf` on Linux or `AppData\Local\Xud\xud.conf` on Windows (run `xud` at least once for this folder to be created). All options with default values are shown below.
 
 ```toml
 [rpc]
 port = 8886
+host = "localhost"
 
 [webproxy]
 disable = false
@@ -142,12 +144,15 @@ host = "localhost"
 
 [p2p]
 listen = true
-port = 8885
-#make sure this port is reachable from the internet
+port = 8885 # Make sure this port is reachable from the internet
+# A string array of reachable socket addresses for this node, port defaults to 8885 if unspecified
+addresses = [ "4.8.15.16:8885" ]
 
 [lnd]
 disable = false
 host = "localhost"
+certpath = "" # The default value is platform-specific
+macaroonpath = "" # The default value is platform-specific
 
 [raiden]
 disable = false