commit 2126a2d8937bb3a9d1c1dd72388f626f253d01aa
parent 4155770e7164c82c3f5f390a2253f2157587b399
Author: NicholasFarrow <nicholas.w.farrow@gmail.com>
Date: Sat, 16 Jan 2021 21:07:05 +1100
Woocommerce docs
Diffstat:
2 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -55,12 +55,15 @@ Now embed the donation button into your website:
```
Changing `YOUR_SERVER_IP` to the IP address of the machine you're running BTCPyment through. Optionally, you can redirect a domain to that IP and use that instead.
+### Using HTTPS & Domains
+Embedded iframes are easy if your site only uses HTTP. But if your site uses HTTPS, then you can see your donation button at `http://YOUR_SERVER_IP:8000/` but will not be able to in an embedded iframe. See [HTTPS instructions](docs/HTTPS.md).
+
+## Payment Gateway (Woocommerce)
+Currently we only support Woocommerce via Wordpress, with plans to extend to others in the future. BTCPyment acts as a custom payment gateway for Woocommerce via the plugin found in `/gateways`. Please click here for installation instructions.
+
## Security
For maximum security, we recommend hosting on a machine where your node only has access to a **watch-only** wallet.
-## Using HTTPS & Domains
-Embedded iframes are easy if your site only uses HTTP. But if your site uses HTTPS, then you can see your donation button at `http://YOUR_SERVER_IP:8000/` but will not be able to in an embedded iframe. See [HTTPS instructions](docs/HTTPS.md).
-
# Developers
### You only need a little python!
The main code can be found in `server.py`. The client logic for the donation button sits in `static/server_connection.js`, invoice structure and bitcoind interface in `invoice/`, button appearance in `template/index.html`. Please have ago at implementing some of the things below!
diff --git a/docs/woocommerce.md b/docs/woocommerce.md
@@ -0,0 +1,8 @@
+# Woocommerce Payment Gateway
+To install the woocommerce payment gateway plugin, first copy `/gateways/woo_btcpyment.php` to your Wordpress site in `wp-content/plugins/`.
+
+Next, in your Wordpress admin area, go to the plugins section and activate BTCPyment. Then go to the Woocommerce settings and the "Payments" tab. Enable BTCPyment as a payment gateway.
+
+
+Click 'Manage' and fill out the required fields and point towards your BTCPyment instance.
+
