-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
96 lines (55 loc) · 5.03 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
=== Askell Registration ===
Contributors: overcast, aldavigdis
Tags: block, paywall, subscription, user registration, membership
Tested up to: 6.4
Requires at least: 6.3
Requires PHP: 8.0
Stable tag: 0.2.0
License: GPL-3.0-or-later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Let your users sign up and pay for for recurring subscriptions directly from your WordPress site using Askell by Overcast Software.
With Askell for WordPress, posts and pages can be restricted to certain subscription tiers using toggle switches in the Block Editor's sidebar.
This plugin adds an interactive block to your WordPress installation that you can use on in the Block Editor, Gutenberg and WordPress FSE enabled WordPress site that facilitates receiving payment information directly from your website, using Askell by Overcast Software.
Askell works as a secure intermediate between your WordPress site and your payment processor and manages information about your paid subscribers, their subsciptions and payment information.
Askell supports the following card payment processors:
* SaltPay (Teya) Credit Card Payments
* Rapyd (formerly Valitor Pay)
== Installation ==
In order to use the plugin, you need to obtain API keys as well as customer and subscription HMAC secrets from Askell.
Enter the API keys and HMAC secrets into the appropriate fields in the Askell section in your wp-admin.
In order to enable registrations, you need to add the Askell Registration block to a page or post on your site. This enables the "Register" button in the paywall.
== Frequently Asked Questions ==
= Which post types are supported? =
The plugin officially supports adding a paywall to WordPress posts and pages only.
= The block or paywall look messy in on my site, what can I do about it? =
We have tested the plugin with various popular themes and value any feedback in that regard. However, if there are inconsistencies or things related to Askell don't look right on your site or in your theme, we recommend modifying your child theme's stylesheet to add the required changes.
= Is the plugin secure? =
The plugin displays a credit card form directly in a WordPress block.
The payment information is transferred over a secure TLS connection to the Askell JSON API from the user's browser and from there to your payment processor, without involving your WordPress database.
This means that credit card information is stored securely by the payment processor of your choice, but not on your WordPress site or Askell itself, reducing the chance of liability in case of a security breach on your site.
We highly recommend that you secure your website my any means you can, including using SSL/TLS encryption and following local data privacy regulations.
= I would like to customise or contribute to the plugin, where can I get the source code? =
We are always happy to receive suggestions and contributions. Our main development branches are at [https://github.com/overcastsoftware/askell-wordpress-plugin](https://github.com/overcastsoftware/askell-wordpress-plugin).
Out Github repository includes build instructions as well as information on installing development dependencies in case you would like to make your own build of the plugin.
Feel free to send us pull requests; or feature requests and bug reports on our Github page.
Please contact us via email at [[email protected]](mailto:[email protected]) or the WordPress Security Team in case you have discovered a security issue that you would like to report.
= Does the plugin support WordPress Multisite? =
The plugin has not been tested with WordPress Multisite as of yet, so Multisite is currently not officially supported. If you are currently using the plugin with WordPress Multisite, we would be happy to hear from you and about your experience.
= Dates and currency values are not in the correct format, what should I do? =
Formatting for currencies and such depends on the language settings of your WordPress installation as well as the ICU library and the PHP Internationalization Functions package installed on your server.
Contact your web host for more information on server-side localisation in PHP.
== 3rd party components ==
The plugin uses the following 3rd party open soruce components:
* [SVG Credit Card & Payment Icons by Aaron Fagan](https://github.com/aaronfagan/svg-credit-card-payment-icons), licensed under the Apache license.
* [Icons from the Twemoji collection](https://twemoji.twitter.com/). Copyright 2020 Twitter, Inc and other contributors. Licensed under Creative Commons CC-BY 4.0: [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).
== Changelog ==
= 0.2.1 =
* Icelandic localisation strings fixed
* Localisation issues in post sidebar panel corrected
= 0.2.0 =
* Various code quality changes
* Now using the user's login name as the reference in Askell instead of ID. This should facilitate bidirectional sync and similar functionality in the future.
= 0.1.1 =
* Registration flow issues fixes
= 0.1.0 =
* Initial development version.