obelisk

commit 5f7d76fd2abc25ea5f38790090d53dbbfec24343
parent d167c2b7957ba2254e48efcc6ad3cd8de83a733b
Author: parazyd <parazyd@dyne.org>
Date:   Tue, 13 Apr 2021 11:52:24 +0200

Add note about dependencies and running in the Readme.

Diffstat:
M
README.md
 | 
14
+++++++++++++-

1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -25,6 +25,13 @@ TODO
 * git grep -E "TODO:|BUG:"
 
 
+Dependencies
+------------
+
+* Python 3
+* pyzmq (python3-zmq or dev-python/pyzmq)
+
+
 Usage
 -----
 
@@ -34,8 +41,13 @@ Set up [obelisk.cfg](res/obelisk.cfg), and run
 ./run_obelisk ./res/obelisk.cfg
 ```
 
+Obelisk can use either public libbitcoin v4 servers, or your local
+libbitcoin-server if you have a running installation. Currently,
+**only testnet v4 public servers are available**, and they're set up
+as default in the configuration file.
+
 Obelisk can also be installed with setuptools:
 
 ```
-python3 setup.py install
+python3 setup.py install --user
 ```