commit d92eb6a1c0e4f3ed63de991fd0b571e86addd5ea
parent 595aa1c260abca02812e42e1a519ce8ed9cb4872
Author: NicholasFarrow <nicholas.w.farrow@gmail.com>
Date: Sun, 27 Dec 2020 11:34:30 +1100
update installation details
Diffstat:
1 file changed, 15 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -1,14 +1,21 @@
# BTCPyment
-Existing non-custodial Bitcoin payment processors are bloated and difficult for the average person to install. BTCPyment strives to exist as an easily deployable, highly customisable, lightweight Bitcoin payment processor that keeps your coins with your keys. Almost purely written in Python and Javascript, BTCPyment makes donation buttons simple; via a simple embedded iframe that talks to your own Bitcoin node via Flask websockets.
+Existing non-custodial Bitcoin payment processors are bloated and difficult for the average person to install. BTCPyment strives to serve as an easily deployable, lightweight Bitcoin payment processor that keeps your coins with your keys by connecting to your own Bitcoin node.
-# Installation
-## Install
+## Demonstration
+
+
+BTCPyment makes donation buttons simple; using Python and Javascript to talk to your own Bitcoin node, with an easy embed install. BTCPyment uses RPC to generate new addresses from your Bitcoin node, and monitors the payment status with your own copy of the blockchain. Soon, we hope to support lightning payments as well as function as a payment processor for a variety of web shops (woocommerce, shopify).
+
+# Installation (easy!)
+BTCPyment requires a connection to a Bitcoin node. If you don't have one, you should [install one](https://bitcoincore.org/en/download/)!
+### Install
Clone and install dependencies
```
git clone https://github.com/nickfarrow/BTCPyment
-pip install -r requirements.txt
+cd BTCPyment/
+pip3 install -r requirements.txt
```
-## Connect to your Bitcoin Node
+### Connect to your Bitcoin Node
Edit the `config.py` configuration and point to your Bitcoin node:
```python
host = "127.0.0.1"
@@ -16,12 +23,11 @@ rpcport = "8332"
username = "bitcoinrpc"
password = "RPCPASSWORD"
```
-(You can find these in `~/.bitcoin/bitcoin.conf`). If your node is remote to your website, you can specify an ssh `tunnel_host = "pi@192.168.0.252"`.
+(You can find these in `~/.bitcoin/bitcoin.conf`). If your node is remote to your website, you can specify an SSH `tunnel_host = "pi@192.168.0.252"` that will forward `rpcport`.
-## Run BTCPyment
-Run server with
+### Run BTCPyment
+Run BTCPyment with
```
-cd BTCPyment/
gunicorn --worker-class eventlet -w 1 server:app
```
That's it! You should now be able to view your BTCPyment server at http://YOUR_SERVER_IP:8000/. If running locally, this will be `127.0.0.1:8000`.
