commit 9ba9ae125d5fc2b17616856920225a8afd018dc3
parent 75e7341364967da36808d6cfba70e12f556bcc8b
Author: nickfarrow <nicholas.w.farrow@gmail.com>
Date: Sun, 15 Aug 2021 21:32:32 +1000
Add links to docs page for API
Diffstat:
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Donation Button -----> | Bitcoin Payment Gateway
+ [Using HTTPS & Domains](#using-https---domains)
+ [Security](#security)
+ [Payment Gateway (Woocommerce)](#payment-gateway--woocommerce-)
+- [Docs](#Docs)
- [Contributions welcomed](#contributions-welcomed)
- [Coming soon](#coming-soon)
- [Disclaimer](#disclaimer)
@@ -33,11 +34,12 @@ SatSale makes donation buttons simple - easy copy paste the one line HTML iframe
* Direct peer-to-peer payments without any middleman. No KYC, and greater privacy than donation systems wher Bitcoin addresses are reused multiple times.
* **Lightweight and highly extendable, basic html and css stying. Modular Python backend**, take a [look at the code](satsale.py) or [lnd.py](/pay/lnd.py)!
* Natively extendable to all bitcoind node features (e.g. segwit) through RPC.
-* QR codes, customizable required payment confirmations and payment expiry time.
+* Reusable and extendable [API](https://satsale.org/docs.html).
* No shitcoin bloat. Bitcoin only.
+
# Installation (short!)
-You require a Bitcoin node, if you don't one you should [install one](https://bitcoincore.org/en/download/) preferably on a Raspberry Pi / server (VPS). While you can run SatSale on this same machine, a separate VPS is recommended.
+You require a Bitcoin node, if you don't one you should [install one](https://bitcoincore.org/en/download/) preferably on a [Raspberry Pi](https://github.com/kdmukai/raspi4_bitcoin_node_tutorial) / server (VPS). While you can run SatSale on this same machine, a separate VPS is recommended.
### Install
Clone and install dependencies
```
@@ -54,7 +56,7 @@ username = "RPCUSERNAME"
password = "RPCPASSWORD"
```
(You can find these in `~/.bitcoin/bitcoin.conf`).
-When connecting to a remote node, also edit either the SSH `tunnel_host` (or see [tor hidden service](/docs/tor.md)). If you havlightning node (lnd) and want to use lightning network payments, see [Lightning instructions](docs/lightning.md). More [example configs](docs/).
+When connecting to a remote node, also edit either the SSH `tunnel_host` (or see [tor hidden service](/docs/tor.md)). If you have a lightning node (lnd) and want to use lightning network payments, see [Lightning instructions](docs/lightning.md). More [example configs](docs/).
### Run SatSale
Run SatSale with
@@ -89,6 +91,10 @@ For maximum security, we recommend hosting on a machine where your node only has
### Payment Gateway (Woocommerce)
Currently we have a plugin for Woocommerce in Wordpress that makes Bitcoin webstores extremely easy, [please click here for installation instructions](docs/woocommerce.md). SatSale acts as a custom payment gateway for Woocommerce via the php plugin found in `/gateways`. We have plans to extend to other web stores in the future.
+# Docs
+* Basic [API docs](https://satsale.org/docs.html)
+* Example [configs, Tor, HTTPS, nginx, etc](docs/)
+
# Contributions welcomed
### You only need a little python!
The main code can be found in [satsale.py](satsale.py). The client-side logic for initiating the payment and querying the API sits in [static/satsale.js](static/satsale.js), button appearance in [templates/index.html](templates/index.html), and Woocommerce plugin in [gateways/woo_satsale.php](gateways/woo_satsale.php). Please have ago at implementing some of the things below or in the issues!
