Skip to content

Updated README #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Klakurka merged 3 commits into from
May 10, 2025
Merged

Updated README #61

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f02f34c
Updated README
May 9, 2025
d814628
Updated README
May 9, 2025
eff0ade
Remove accidentally committed files
May 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Tags: paywall, monetization, donation, crypto, ecash
Requires at least: 5.0
Tested up to: 6.8
Requires PHP: 7.0
Stable tag: 3.0.0
Stable tag: 3.1.0
PayButton Client: 4.1.0
PayButton Client URI: https://github.com/PayButton/paybutton
License: MIT
Expand Down Expand Up @@ -50,6 +50,9 @@ No – PayButton’s no-signup approach uses session tracking and database entri
=03. Can I customize the appearance of the paywall?=
Absolutely, the admin dashboard allows you to modify button texts, pricing, color schemes, and more to match your theme.

=04. Will PayButton’s cookies break page caching?=
No. PayButton sets two HMAC-signed paybutton_user_wallet_address and paybutton_paid_content to track user wallet address and unlocked content. Cookies only get updated (and send a Set-Cookie header) when their value actually changes, so full-page caches (e.g. WP Super Cache, W3 Total Cache) and server caches (Nginx, Varnish) remain valid.

== Screenshots ==
1. Admin Dashboard Overview
2. Frontend PayButton Paywall in Action
Expand All @@ -61,22 +64,23 @@ Absolutely, the admin dashboard allows you to modify button texts, pricing, colo
== External services ==

- PayButton websocket
This plugin connects to the PayButton WebSocket, a service that monitors blockchain transactions.
It is used to detect payments made to the PayButton/Widget address in real time.
The plugin uses the provided address to establish a connection and begins listening for events emitted when new transactions are detected.
This service is provided by PayButton: terms of use[https://github.com/PayButton/paybutton-server/blob/master/TERMS.md], privacy policy[https://github.com/PayButton/paybutton-server/blob/master/PRIVACY.md].
This plugin connects to the PayButton WebSocket, a service that monitors blockchain transactions. It is used to detect payments made to the PayButton/Widget address in real time. The plugin uses the provided address to establish a connection and begins listening for events emitted when new transactions are detected. This service is provided by PayButton: [terms of use](https://github.com/PayButton/paybutton-server/blob/master/TERMS.md), [privacy policy](https://github.com/PayButton/paybutton-server/blob/master/PRIVACY.md).

- PayButton API
This plugin communicates with the PayButton API to fetch information about the address and its transactions.
It provides data such as the transaction price and the address balance, which are used by the widget and the button.
This service is also provided by PayButton: terms of use[https://github.com/PayButton/paybutton-server/blob/master/TERMS.md], privacy policy[https://github.com/PayButton/paybutton-server/blob/master/PRIVACY.md].
This plugin communicates with the PayButton API to fetch information about the address and its transactions. It provides data such as the transaction price and the address balance, which are used by the widget and the button. This service is also provided by PayButton: [terms of use](https://github.com/PayButton/paybutton-server/blob/master/TERMS.md), [privacy policy](https://github.com/PayButton/paybutton-server/blob/master/PRIVACY.md).

- SideShift.AI API
The integration uses the SideShift API to enable the button or widget to accept payments in a different currency than the one being received.
This service is provided by SideShift.AI [terms of use][https://sideshift.ai/legal].
The integration uses the SideShift API to enable the button or widget to accept payments in a different currency than the one being received. This service is provided by SideShift.AI: [terms of use](https://sideshift.ai/legal).

== Changelog ==

= 3.1.0 (2025/05/10) =
* Added nonce verification and user capability checks for enhanced security.
* Added paybutton_ prefix to all generic option names to avoid naming conflicts.
* Escaped variables properly when echoed to prevent XSS vulnerabilities.
* Replaced session usage with cookies for improved caching compatibility and plugin support.
* Updated the plugin's README file with latest plugin details and usage instructions.

= 3.0.0 (2025/03/21) =
* Enhanced admin wallet address configuration flow.
* Implemented wallet address validation feature using the ecashaddrjs library.
Expand Down Expand Up @@ -114,6 +118,6 @@ This service is provided by SideShift.AI [terms of use][https://sideshift.ai/leg

== Upgrade Notice ==

= 3.0.0+ =
Upgrade to version 3.0.0+ for improved compatibility and reliability.
=======
= 3.1.0 =
Upgrade to version 3.1.0 for improved compatibility and reliability.
=======