diff --git a/README.md b/README.md new file mode 100644 index 00000000..e20db09a --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# squeakserver + +Server for Squeak protocol + +## Test + +### Run unit tests: + +``` +$ make test +``` + +### Run integration tests: + +``` +$ make itest +``` + +## Run + +### Run with docker: + +- Edit **docker/config.ini** to use your external IP address for `external_host` +- Start the squeak server: + ``` + $ cd docker + $ docker-compose up + ``` + +### Run without docker: + +- Create a **config.ini** file and fill in the relevant values: + ``` + [DEFAULT] + network=testnet + + [lnd] + host= + external_host= + port=9735 + rpc_port=10009 + tls_cert_path=/root/.lnd/tls.cert + macaroon_path=/root/.lnd/data/chain/bitcoin/testnet/admin.macaroon + + [server] + rpc_host=0.0.0.0 + rpc_port=8774 + price= + + [postgresql] + host= + database=squeakserver + user=postgres + password=postgres + ``` +- Run the **createdb.sql** script on the postgres server to initialize the database. +- Install the server requirements: + ``` + $ pip3 install -r requirements.txt + $ install-rpc.sh + $ python3 setup.py install + ``` +- Start the squeak server: + ``` + $ runsqueakserver --config config.ini run-server + ``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 9abe2528..00000000 --- a/README.rst +++ /dev/null @@ -1,26 +0,0 @@ -squeakserver -====== - -Server for squeak protocol - -Install -------- - - -Run ---- - - -Test ----- - -:: - - $ make test - $ make itest - -Run with coverage report:: - - $ coverage run -m pytest - $ coverage report - $ coverage html # open htmlcov/index.html in a browser diff --git a/setup.py b/setup.py index bc79e4c0..c8d89099 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ import io from setuptools import find_packages from setuptools import setup -with io.open("README.rst", "rt", encoding="utf8") as f: +with io.open("README.md", "rt", encoding="utf8") as f: readme = f.read() setup(