Skip to content

Commit

Permalink
Updating installation instructions with latest documentation references.
Browse files Browse the repository at this point in the history
  • Loading branch information
ndeet committed Feb 28, 2022
1 parent 0e0593e commit 2b4ebbd
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 25 deletions.
4 changes: 2 additions & 2 deletions btcpay-greenfield-for-woocommerce.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* Author URI: https://btcpayserver.org
* Text Domain: btcpay-greenfield-for-woocommerce
* Domain Path: /languages
* Version: 0.2.2
* Version: 0.2.3
* Requires PHP: 7.4
* Tested up to: 5.9
* Requires at least: 5.2
Expand All @@ -20,7 +20,7 @@

defined( 'ABSPATH' ) || exit();

define( 'BTCPAYSERVER_VERSION', '0.2.2' );
define( 'BTCPAYSERVER_VERSION', '0.2.3' );
define( 'BTCPAYSERVER_PLUGIN_FILE_PATH', plugin_dir_path( __FILE__ ) );
define( 'BTCPAYSERVER_PLUGIN_URL', plugin_dir_url(__FILE__ ) );
define( 'BTCPAYSERVER_PLUGIN_ID', 'btcpay-greenfield-for-woocommerce' );
Expand Down
43 changes: 20 additions & 23 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Tags: bitcoin, btcpay, BTCPay Server, btcpayserver, WooCommerce, payment gateway
Requires at least: 5.2
Tested up to: 5.9
Requires PHP: 7.4
Stable tag: 0.2.1
Stable tag: 0.2.3
License: MIT
License URI: https://github.com/btcpayserver/woocommerce-greenfield-plugin/blob/master/license.txt

Expand Down Expand Up @@ -39,66 +39,59 @@ The self-hosted solution allows you not only to attach an unlimited number of st

== Installation ==

This plugin requires Woocommerce. Please make sure you have Woocommerce installed.
This plugin requires WooCommerce. Please make sure you have WooCommerce installed.

<img src="https://github.com/btcpayserver/btcpayserver-doc/blob/master/img/BTCPayWooCommerceInfoggraphic.png" alt="Infographic" />

To integrate BTCPay Server into an existing WooCommerce store, follow the steps below.
To integrate BTCPay Server into an existing WooCommerce store, follow the steps below or check our official [installation instructions](https://docs.btcpayserver.org/WooCommerce/).

### 1. Install BTCPay WooCommerce Plugin ###
### 1. Deploy BTCPay Server (optional) ###

### 2. Deploy BTCPay Server ###
This step is optional, if you already have a BTCPay Server instance setup you can skip to section 2. below. To launch your BTCPay server, you can self-host it, or use a third party host.

To launch your BTCPay server, you can self-host it, or use a third party host.

#### 2.1 Self-hosted BTCPay ####
#### 1.1 Self-hosted BTCPay ####

There are various ways to [launch a self-hosted BTCPay](https://github.com/btcpayserver/btcpayserver-doc#deployment). If you do not have technical knowledge, use the [web-wizard method](https://launchbtcpay.lunanode.com) and follow the video below.

https://www.youtube.com/watch?v=NjslXYvp8bk

For the self-hosted solutions, you will have to wait for your node to sync fully before proceeding to step 3.

#### 2.2 Third-party host ####
#### 1.2 Third-party host ####

Those who want to test BTCPay out, or are okay with the limitations of a third-party hosting (dependency and privacy, as well as lack of some features) can use a one of many [third-party hosts](ThirdPartyHosting.md).

The video below shows you how to connect your store to such host.

https://www.youtube.com/watch?v=IT2K8It3S3o

### 3. Pairing the store ###
### 2. Install BTCPay WooCommerce Plugin ###

BTCPay WooCommerce plugin is a bridge between your BTCPay Server (payment processor) and your e-commerce store. No matter if you are using a self-hosted or third-party solution from step 2, the pairing process is identical.
BTCPay WooCommerce plugin is a bridge between your BTCPay Server (payment processor) and your e-commerce store. No matter if you are using a self-hosted or third-party solution from step 1., the connection process is identical.

Go to your store dashboard. WooCommerce > Settings > BTCPay Settings.
You can find detailed installation instructions on our [WooCommerce documentation](https://docs.btcpayserver.org/WooCommerce/).

1. In the field, enter the full URL of your host (including the https) – https://btcpay.mydomain.com
2. Click on the "click here to generate API keys" link to get redirected to BTCPay Server Authorization page.
3. On BTCPay Server make sure you select one single store you want to connect your WooCommerce shop.
4. Click on the [Authorize app] button, you will get redirected back to WooCommerce BTCPay Settings page and your store ID will already be prefilled.
5. Optional: Change other settings as needed.
6. Click [Save] button.
7. You can now enable BTCPay payment gateway in WooCommerce > Settings > Payments
Here is a quick walkthrough if you prefer a video:

https://www.youtube.com/watch?v=a-MQHgnjNXI&t=2s

### 4. Connecting your wallet ###
### 3. Connecting your wallet ###

No matter if you're using self-hosted or server hosted by a third-party, the process of configuring your wallet is the same.

https://www.youtube.com/watch?v=xX6LyQej0NQ

### 5. Testing the checkout ###
### 4. Testing the checkout ###

Making a small test-purchase from your own store, will give you a piece of mind. Always make sure that everything is set up correctly before going live. The final video, guides you through the steps of setting a gap limit in your Electrum wallet and testing the checkout process.

https://www.youtube.com/watch?v=Fi3pYpzGmmo

Depending on your business model and store settings, you may want to [configure your order statuses](https://nbitstack.com/t/how-to-set-up-order-statuses-in-woocommerce-and-btcpay/67).
Depending on your business model and store settings, you may want to fine tune [your order statuses](https://docs.btcpayserver.org/WooCommerce/#41-global-settings).

== Frequently Asked Questions ==

You'll find extensive documentation and answers to many of your questions on [docs.btcpayserver.org](https://docs.btcpayserver.org/).
You'll find extensive documentation and answers to many of your questions on [BTCPay for WooCommerce V2 docs](https://docs.btcpayserver.org/WooCommerce) and on [BTCPay for WooCommerce integrations FAQ](https://docs.btcpayserver.org/FAQ/Integrations/#woocommerce-faq).

== Screenshots ==

Expand All @@ -110,6 +103,10 @@ You'll find extensive documentation and answers to many of your questions on [do
6. Example of the PoS app you can launch.

== Changelog ==
= 0.2.3 :: 2022-02-28 =
* Adding irrelevant GitHub workflow files to .distignore.
* Updating installation instructions with new material.

= 0.2.2 :: 2022-02-28 =
* Fix fatal error, make sure is_plugin_active() is available.

Expand Down

0 comments on commit 2b4ebbd

Please sign in to comment.