Update readme (#61)

* Update readme

* Fix underlines in readme

* Fix config file reference in readme

* Use markdown for readme

* Fix markdown readme
This commit is contained in:
Jonathan Zernik 2020-07-02 21:18:10 -07:00 committed by GitHub
parent 120befd511
commit fd2b31a2a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 67 additions and 27 deletions

66
README.md Normal file
View file

@ -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=<YOUR_LND_HOST>
external_host=<YOUR_LND_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=<YOUR_SELLING_PRICE_IN_SATOSHIS>
[postgresql]
host=<YOUR_POSTGRES_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
```

View file

@ -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

View file

@ -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(