Adding readme.txt infos, readme, wordpress-org images (WIP), github workflow.
57
.github/workflows/wp-release.yml
vendored
Normal file
@ -0,0 +1,57 @@
|
||||
name: Build and deploy to WordPress.org
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
jobs:
|
||||
tag:
|
||||
name: New release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install Composer dependencies
|
||||
uses: php-actions/composer@v6
|
||||
with:
|
||||
dev: no
|
||||
php_version: 8.1
|
||||
php_extensions: bcmath
|
||||
|
||||
- name: Install WP-CLI
|
||||
run: |
|
||||
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
|
||||
chmod +x wp-cli.phar
|
||||
sudo mv wp-cli.phar /usr/local/bin/wp
|
||||
|
||||
# - name: Set up Node.js
|
||||
# uses: actions/setup-node@v3
|
||||
# with:
|
||||
# node-version: '16'
|
||||
|
||||
# - name: Set Execute Permissions for build_i18n.sh
|
||||
# run: chmod +x bin/build_i18n.sh
|
||||
|
||||
# - name: Build assets and translation files
|
||||
# run: |
|
||||
# npm install
|
||||
# npm run build
|
||||
|
||||
- name: WordPress Plugin Deploy
|
||||
id: deploy
|
||||
uses: 10up/action-wordpress-plugin-deploy@stable
|
||||
with:
|
||||
generate-zip: true
|
||||
env:
|
||||
SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
|
||||
SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
|
||||
SLUG: btcpay-givewp
|
||||
|
||||
- name: Upload release asset
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ github.event.release.upload_url }}
|
||||
asset_path: ${{ steps.deploy.outputs.zip-path }}
|
||||
asset_name: btcpay-for-givewp.zip
|
||||
asset_content_type: application/zip
|
||||
BIN
.wordpress-org/banner-1544x500.png
Normal file
|
After Width: | Height: | Size: 223 KiB |
BIN
.wordpress-org/banner-772x250.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
.wordpress-org/icon-128x128.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
.wordpress-org/icon-256x256.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
.wordpress-org/screenshot-1.png
Normal file
|
After Width: | Height: | Size: 93 KiB |
BIN
.wordpress-org/screenshot-2.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
BIN
.wordpress-org/screenshot-3.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
.wordpress-org/screenshot-4.png
Normal file
|
After Width: | Height: | Size: 112 KiB |
24
README.md
Normal file
@ -0,0 +1,24 @@
|
||||
# BTCPay for GiveWP
|
||||
|
||||
For a detailed feature overview and description go to the official WordPress plugin page:
|
||||
https://wordpress.org/plugins/btcpay-for-givewp/ or [readme.txt](readme.txt) in this diretory.
|
||||
|
||||
This readme is mostly about plugin development on the main repo on GitHub.
|
||||
|
||||
|
||||
## Todo for new features or known issues
|
||||
Check the issues on the repo here:
|
||||
https://github.com/btcpayserver/givewp/issues
|
||||
|
||||
## Development
|
||||
```
|
||||
git clone git@github.com:btcpayserver/givewp.git
|
||||
```
|
||||
|
||||
**Install dependencies with Composer:**
|
||||
```
|
||||
composer install
|
||||
```
|
||||
|
||||
### Contributing
|
||||
Feel free to open an issue to discuss a feature or provide a PR for any improvements or if you want to tackle a feature listed in the issues.
|
||||
92
readme.txt
@ -13,7 +13,97 @@ A BTCPay Server Bitcoin / Lightning Network (and other cryptocurrencies) payment
|
||||
|
||||
== Description ==
|
||||
|
||||
This plugin requires the GiveWP core plugin activated to function properly.
|
||||
= Accept Bitcoin donations in your GiveWP powered WordPress site with BTCPay Server =
|
||||
|
||||
BTCPay Server for GiveWP is a revolutionary, self-hosted, open-source payment gateway to accept Bitcoin payments. Our **seamless integration** with GiveWP allows you to connect your self-hosted [BTCPay Server](https://btcpayserver.org) and start accepting Bitcoin payments in **[just a few simple steps](https://docs.btcpayserver.org/GiveWP)**.
|
||||
|
||||
= Features: =
|
||||
|
||||
* **Zero fees**: Enjoy a payment gateway with no fees. Yes, really!
|
||||
* **Fully automated system**: BTCPay takes care of payments, invoice management and refunds automatically.
|
||||
* **Display Bitcoin QR code at checkout**: Enhance customer experience with an easy and secure payment option.
|
||||
* **No middlemen or KYC**:
|
||||
* Direct, P2P payments (going directly to your wallet)
|
||||
* Say goodbye to intermediaries and tedious paperwork
|
||||
* Transaction information is only shared between you and your customer
|
||||
* **Self-hosted infrastructure**: Maintain full control over your payment gateway.
|
||||
* **Direct wallet payments**: Be your own bank with a self-custodial service.
|
||||
* **Lightning Network** integrated out of the box - instant, fast and low cost payments and payouts
|
||||
* **Reporting and accounting** - CSV exports
|
||||
* **Advanced invoice management**
|
||||
* **Real-time exchange price tracking** for correct payment amounts
|
||||
* **Versatile plugin system**:
|
||||
* Extend functionality according to your needs
|
||||
* Accept payments in altcoins through various plugins
|
||||
* **Elegant checkout design**: Compatible with all Bitcoin wallets and enhanced with your store's logo and branding for a unique UX.
|
||||
* **Point-of-sale** integration - Accept payments in your physical shops
|
||||
* **Multilingual ready**: Serve a global audience right out of the box.
|
||||
* **Top-notch privacy and security**: Protect your and your customers' data.
|
||||
* **Community-driven support**: Get responsive assistance from our dedicated community ([Mattermost](http://chat.btcpayserver.org) or [Telegram](https://t.me/btcpayserver)).
|
||||
* Extensive [documentation](https://docs.btcpayserver.org/GiveWP)
|
||||
|
||||
The non-profit [BTCPay Server Foundation ](https://foundation.btcpayserver.org) is committed to keeping this powerful payment gateway free forever. Our mission is to enable anyone to accept bitcoin regardless of financial, technical, social or political barriers.
|
||||
|
||||
|
||||
== Installation ==
|
||||
|
||||
This plugin requires GiveWP. Please make sure you have GiveWP installed.
|
||||
|
||||
To add BTCPay Server as payment gateway to GiveWP, follow the steps below or check our official [installation instructions](https://docs.btcpayserver.org/GiveWP/).
|
||||
|
||||
### 1. Deploy BTCPay Server (optional) ###
|
||||
|
||||
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.
|
||||
|
||||
#### 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.
|
||||
|
||||
#### 1.2 Third-party host ####
|
||||
|
||||
Those who just 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 a host.
|
||||
|
||||
https://www.youtube.com/watch?v=IT2K8It3S3o
|
||||
|
||||
### 2. Install BTCPay for GiveWP Plugin ###
|
||||
|
||||
BTCPay for GiveWP plugin is a bridge between your BTCPay Server (payment processor) and your donation forms. No matter if you are using a self-hosted or third-party solution from step 1., the connection process is identical.
|
||||
|
||||
You can find detailed installation instructions on our [GiveWP documentation](https://docs.btcpayserver.org/GiveWP/).
|
||||
|
||||
### 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
|
||||
|
||||
### 4. Testing the checkout ###
|
||||
|
||||
Making a small test-donation, 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.
|
||||
|
||||
== Frequently Asked Questions ==
|
||||
|
||||
You'll find extensive documentation and answers to many of your questions on [BTCPay for GiveWP docs](https://docs.btcpayserver.org/GiveWP).
|
||||
|
||||
== Screenshots ==
|
||||
|
||||
1. Provides a Bitcoin / Lightning Network (and other) payment gateway on checkout.
|
||||
2. Your customers can pay by scanning the QR-Code with their wallet or copy and paste the receiving address.
|
||||
3. After successful payment the customers will get redirected to the order page. The order will be marked as paid automatically.
|
||||
4. On BTCPay Server you have extensive reporting and accounting features.
|
||||
|
||||
== Upgrade Notice ==
|
||||
|
||||
= 1.0.0 =
|
||||
* Initial release
|
||||
|
||||
|
||||
== Changelog ==
|
||||
= 1.0.0 :: 2025-04-02 =
|
||||
* Initial release
|
||||
|
||||