From 6698a1a8925d5a55c0c174b05b9cc8b04ee18aeb Mon Sep 17 00:00:00 2001
From: Sergi Delgado Segura <sergi.delgado.s@gmail.com>
Date: Tue, 9 Jun 2020 09:25:07 +0200
Subject: [PATCH] docs - updates readme with feed data

---
 README.md    |  4 +++-
 teos/help.py | 20 +++++++++++---------
 2 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 33b95af..72187d6 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,8 @@ Notice that ENV variables are optional, if unset the corresponding default setti
 - BTC_RPC_PORT=<btc node port>
 - BTC_RPC_USER=<rpc username>
 - BTC_RPC_PASSWORD=<rpc password>
+- BTC_FEED_CONNECT=<btc zmq hostname>
+- BTC_FEED_PORT=<btc zmq port>
 ```
 
 If you are running `teos` and `bitcoind` in the same machine, continue reading for how to create the container based on your OS.
@@ -122,7 +124,7 @@ Notice that you may still need to set your RPC authentication details, since, ho
 Docker for OSX and Windows do not allow to use the host network (nor to use the `docker0` bridge interface). To workaround this
 you can use the special `host.docker.internal` domain.
 
-    docker run -it -e BTC_RPC_CONNECT=host.docker.internal -e BTC_RPC_USER=<rpc username> -e BTC_RPC_PASSWD=<rpc password> teos
+    docker run -p 9814 -it -e BTC_RPC_CONNECT=host.docker.internal -e BTC_FEED_CONNECT=host.docker.internal -e BTC_RPC_USER=<rpc username> -e BTC_RPC_PASSWD=<rpc password> teos
 
 ## Interacting with a TEOS Instance
 
diff --git a/teos/help.py b/teos/help.py
index 090a624..c46b101 100644
--- a/teos/help.py
+++ b/teos/help.py
@@ -2,15 +2,17 @@ def show_usage():
     return (
         "USAGE: "
         "\n\tpython teosd.py [global options]"
-        "\n\nGLOBAL OPTIONS:"
-        "\n\t--apibind \t\taddress that teos API will bind to. Defaults to 'localhost' (modifiable in conf file)."
-        "\n\t--apiport \t\tport that teos API will bind to. Defaults to '9814' (modifiable in conf file)."
+        "\n\nGLOBAL OPTIONS (all modifiable in conf file):"
+        "\n\t--apibind \t\taddress that teos API will bind to. Defaults to 'localhost'."
+        "\n\t--apiport \t\tport that teos API will bind to. Defaults to '9814'."
         "\n\t--btcnetwork \t\tNetwork bitcoind is connected to. Either mainnet, testnet or regtest. Defaults to "
-        "'mainnet' (modifiable in conf file)."
-        "\n\t--btcrpcuser \t\tbitcoind rpcuser. Defaults to 'user' (modifiable in conf file)."
-        "\n\t--btcrpcpassword \tbitcoind rpcpassword. Defaults to 'passwd' (modifiable in conf file)."
-        "\n\t--btcrpcconnect \tbitcoind rpcconnect. Defaults to 'localhost' (modifiable in conf file)."
-        "\n\t--btcrpcport \t\tbitcoind rpcport. Defaults to '8332' (modifiable in conf file)."
-        "\n\t--datadir \t\tspecify data directory. Defaults to '~\.teos' (modifiable in conf file)."
+        "'mainnet'."
+        "\n\t--btcrpcuser \t\tbitcoind rpcuser. Defaults to 'user'."
+        "\n\t--btcrpcpassword \tbitcoind rpcpassword. Defaults to 'passwd'."
+        "\n\t--btcrpcconnect \tbitcoind rpcconnect. Defaults to 'localhost'."
+        "\n\t--btcrpcport \t\tbitcoind rpcport. Defaults to '8332'."
+        "\n\t--btcfeedconnect \tbitcoind zmq hostname (for blocks). Defaults to 'localhost'."
+        "\n\t--btcfeedport \t\tbitcoind zmq port (for blocks). Defaults to '28332'."
+        "\n\t--datadir \t\tspecify data directory. Defaults to '~\.teos'."
         "\n\t-h --help \t\tshows this message."
     )