readme.txt 7.63 KB
Newer Older
Michael Iseard's avatar
Michael Iseard committed
1
=== Kudos Donations - Easy donations and payments with Mollie ===
2
Contributors: iseardmedia
Michael Iseard's avatar
Michael Iseard committed
3
Tags: donation, mollie, payment, ideal, credit card
Michael Iseard's avatar
Michael Iseard committed
4
Requires at least: 5.5
5
Tested up to: 5.6
6
Requires PHP: 7.1
Michael Iseard's avatar
Michael Iseard committed
7
Stable tag: 2.3.2
Michael Iseard's avatar
Michael Iseard committed
8
9
10
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Michael Iseard's avatar
Michael Iseard committed
11
Add a donation button to any page on your website. Easy & fast setup. Works with Mollie payments.
Michael Iseard's avatar
Michael Iseard committed
12
13
14

== Description ==

Michael Iseard's avatar
Michael Iseard committed
15
= A modern and easy to use donation plugin =
Michael Iseard's avatar
Michael Iseard committed
16

Michael Iseard's avatar
Michael Iseard committed
17
*Kudos Donations* allows you to add a donate button anywhere on your website. Once a user clicks this button they will be greeted with a pop-up window where they can enter their details and how much they would like to donate.
Michael Iseard's avatar
Michael Iseard committed
18

Michael Iseard's avatar
Michael Iseard committed
19
20
21
22
= Features and highlights =

* Smart and modern design.
* Can add as many different buttons as you like.
Michael Iseard's avatar
Michael Iseard committed
23
* Connect with Mollie for secure payments by credit card, iDEAL and [many others](https://www.mollie.com/payments).
Michael Iseard's avatar
Michael Iseard committed
24
* Toggle Automated email receipts.
Michael Iseard's avatar
Michael Iseard committed
25
26
27
* Use custom SMTP email settings.
* Gutenberg block or shortcode to place your button virtually anywhere.
* Customize the donation form, button and thank you message.
Michael Iseard's avatar
Michael Iseard committed
28
* Choose a colour scheme.
Michael Iseard's avatar
Michael Iseard committed
29
* View and manage individual transactions, subscriptions, donors and campaigns from the admin menu.
Michael Iseard's avatar
Michael Iseard committed
30
31

= Easy to use =
32
33
34
Just enter your API key from Mollie, then add one or more buttons anywhere on you website. You can add a button using either the provided *Kudos Button* block or with a shortcode. Please see the FAQ below for shortcode use.

Need a Mollie account? Visit their website to [get started](https://www.mollie.com/).
Michael Iseard's avatar
Michael Iseard committed
35

Michael Iseard's avatar
Michael Iseard committed
36
= Campaigns =
Michael Iseard's avatar
Michael Iseard committed
37
Create campaigns to easily group and track donations made by your donors. Each campaign can have a unique configuration which can be changed from the settings page and automatically applied to all your buttons.
Michael Iseard's avatar
Michael Iseard committed
38

Michael Iseard's avatar
Michael Iseard committed
39
= Recurring Payments =
Michael Iseard's avatar
Michael Iseard committed
40
Allow donors to create a donation subscription to support your organization on a regular basis. Kudos Donations will automatically create the subscription and take payments from Mollie. You can also disable this and use only one-off payments if you prefer.
Michael Iseard's avatar
Michael Iseard committed
41

Michael Iseard's avatar
Michael Iseard committed
42
43
44
= Source =
The Git repository for this plugin can be found [here](https://gitlab.iseard.media/michael/kudos-donations).

Michael Iseard's avatar
Michael Iseard committed
45
46
== Installation ==

Michael Iseard's avatar
Michael Iseard committed
47
48
49
1. Install using the WordPress plugin control panel or manually download the plugin and upload the *kudos-donations* folder to the /wp-content/plugins/ directory
1. Activate the plugin through the *Plugins* menu in WordPress.
1. Go to the 'Kudos Settings' menu in the dashboard and follow the instructions to get started.
Michael Iseard's avatar
Michael Iseard committed
50
51
52

== Frequently Asked Questions ==

Michael Iseard's avatar
Michael Iseard committed
53
54
= Is Kudos Donations free? =

Michael Iseard's avatar
Michael Iseard committed
55
Yes, Kudos Donations is a free open-source plugin.
Michael Iseard's avatar
Michael Iseard committed
56

Michael Iseard's avatar
Michael Iseard committed
57
= Which payment methods are supported? =
Michael Iseard's avatar
Michael Iseard committed
58

Michael Iseard's avatar
Michael Iseard committed
59
This plugin uses Mollie as a payment vendor. Mollie allows you to pay using a wide range of payment methods such as iDeal, Credit Card and PayPal. For a full list of payment methods please check out [this link](https://www.mollie.com/en/payments).
Michael Iseard's avatar
Michael Iseard committed
60

Michael Iseard's avatar
Michael Iseard committed
61
62
63
64
= How much does Mollie cost? =

Mollie registration is free and you only pay a small fee per transaction. See [here](https://www.mollie.com/pricing) for details.

Michael Iseard's avatar
Michael Iseard committed
65
66
67
68
69
70
71
72
= Can anyone use Mollie? =

Mollie is available to anyone with a registered company.

= Can I use Kudos Donations in my country? =

You can use this plugin in any country that is supported by Mollie. For a complete list please see [here](https://help.mollie.com/hc/articles/115002116105-Can-I-use-Mollies-services-in-my-country-)

73
74
75
76
77
78
79
80
81
82
83
84
= How do I use the shortcode? =

For general information on how to use shortcodes, please visit [this page](https://codex.wordpress.org/shortcode).

To get started add the Kudos Donations shortcode:

~~~
[kudos]
~~~

Here is a list of the shortcode attributes:

Michael Iseard's avatar
Michael Iseard committed
85
* *button_label* = The label to display for the button.
Michael Iseard's avatar
Michael Iseard committed
86
* *campaign_id* = Id of the campaign to use for this button.
87
88
89
90

e.g:

~~~~
Michael Iseard's avatar
Michael Iseard committed
91
[kudos button_label="Donate now" campaign_id="default"]
92
93
~~~~

Michael Iseard's avatar
Michael Iseard committed
94
95
== Screenshots ==

Michael Iseard's avatar
Michael Iseard committed
96
97
1. Donation form
2. Kudos Donations button block
Michael Iseard's avatar
Michael Iseard committed
98
3. Settings page
Michael Iseard's avatar
Michael Iseard committed
99
4. Automated email receipt
Michael Iseard's avatar
Michael Iseard committed
100
101
102

== Changelog ==

Michael Iseard's avatar
Michael Iseard committed
103
104
= 2.3.1 =
* Display campaign_id in campaign header on settings page
Michael Iseard's avatar
Michael Iseard committed
105
106
107
* Fix issues with canceling subscriptions
* Fix various missing translations caused by webpack compression
* Various other minor fixes
Michael Iseard's avatar
Michael Iseard committed
108

Michael Iseard's avatar
Michael Iseard committed
109
= 2.3.0 =
110
* Reworked campaigns, greatly simplifying shortcodes and configuration
Michael Iseard's avatar
Michael Iseard committed
111
* Improved settings page
Michael Iseard's avatar
Michael Iseard committed
112
113
* Switch to REST api to create transactions
* Added welcome guide when settings page first visited
Michael Iseard's avatar
Michael Iseard committed
114
* Added "Help" tab to settings page with useful links
Michael Iseard's avatar
Michael Iseard committed
115
116
* Fixed issue with email used in test mode not working in live
* Fixed issue with email when "From address" left blank
Michael Iseard's avatar
Michael Iseard committed
117

Michael Iseard's avatar
Michael Iseard committed
118
= 2.2.0 =
119
* Add ability to change donation type (subscription, one-off or both) to each button
Michael Iseard's avatar
Michael Iseard committed
120
* Add ability to export/import settings
121
122
* Terms and conditions checkbox not shown if no URL provided in settings
* Remove hook for clearing log as this did not work consistently
123
* Fix transactions link on campaigns page
124
* Various text/translation fixes
Michael Iseard's avatar
Michael Iseard committed
125

Michael Iseard's avatar
Michael Iseard committed
126
127
128
129
= 2.1.1 =
* Fix missing Dutch translations
* Remove unnecessary option to disable Action Scheduler

Michael Iseard's avatar
Michael Iseard committed
130
= 2.1.0 =
Michael Iseard's avatar
Michael Iseard committed
131
* Add option to select 'both' for amount type
Michael Iseard's avatar
Michael Iseard committed
132
* Workaround to fix missing translations from translate.wordpress.org
133
* Log is now cleared every midnight
Michael Iseard's avatar
Michael Iseard committed
134
* Fix issues with payments over 999
Michael Iseard's avatar
Michael Iseard committed
135
136
* Fix email address not validating correctly
* Fix various jQuery deprecations
137
* Fix twig cache issue by clearing cache on activation
Michael Iseard's avatar
Michael Iseard committed
138

Michael Iseard's avatar
Michael Iseard committed
139
= 2.0.8 =
Michael Iseard's avatar
Michael Iseard committed
140
141
* Add 'Recreate database' action to debug menu
* Add confirmation pop-up to debug actions
Michael Iseard's avatar
Michael Iseard committed
142
* Update libraries
Michael Iseard's avatar
Michael Iseard committed
143
144
* Minor bug fixes

Michael Iseard's avatar
Michael Iseard committed
145
146
147
= 2.0.7 =
* Campaign label no longer defaults to page/post title
* Improve look of fixed amount buttons (now limited to 4)
148
149
* Fix REST_API error for mollie/admin in WordPress 5.6
* Fix some visual changes introduced in Twenty Twenty-One
Michael Iseard's avatar
Michael Iseard committed
150
151
152
* Text changes
* Minor bug fixes

Michael Iseard's avatar
Michael Iseard committed
153
154
= 2.0.6 =
* Fix unknown index errors on tables
Michael Iseard's avatar
Michael Iseard committed
155
156
* Fix 'Sync campaign labels' action adding blank campaigns
* Update TailwindCSS to 2.0.1
Michael Iseard's avatar
Michael Iseard committed
157
* Update Dutch translations
Michael Iseard's avatar
Michael Iseard committed
158

Michael Iseard's avatar
Michael Iseard committed
159
160
= 2.0.5 =
* Fixed error deleting donors
Michael Iseard's avatar
Michael Iseard committed
161
* Fix slashes appearing in address
162
163
164
165
* Add select column for table search
* Add 'Last Donation' column to campaign table
* Add debug option to sync campaigns
* Add more Dutch translations
Michael Iseard's avatar
Michael Iseard committed
166
* Add more hooks
167
168
* Use object cache for database queries
* Improve debug logging
Michael Iseard's avatar
Michael Iseard committed
169

Michael Iseard's avatar
Michael Iseard committed
170
171
172
173
= 2.0.4 =
* Added campaigns table
* New campaign block settings allows you to select previous campaigns or add new one

Michael Iseard's avatar
Michael Iseard committed
174
= 2.0.3 =
Michael Iseard's avatar
Michael Iseard committed
175
* Fix modal header not showing correct text
Michael Iseard's avatar
Michael Iseard committed
176
* Fix translations
Michael Iseard's avatar
Michael Iseard committed
177
* Fix debug actions not redirecting to correct tab
Michael Iseard's avatar
Michael Iseard committed
178

Michael Iseard's avatar
Michael Iseard committed
179
180
181
182
= 2.0.2 =
* Add ability to search by campaign in transactions table
* Update Dutch translation

Michael Iseard's avatar
Michael Iseard committed
183
184
185
= 2.0.1 =
* Add ability to clear twig cache from the debug menu

Michael Iseard's avatar
Michael Iseard committed
186
187
188
189
190
191
192
193
= 2.0.0 =
* *Plugin completely rewritten*
* Significantly reduced size and speed
* Brand new settings page built on React
* Ability for customers to create subscriptions
* Ability to switch between open and fixed donation amounts
* Action scheduler integration for quicker payments/emails

194
195
= 1.1.0 =
* *Added* - Email receipts - You can now configure email server settings and enable automatic email receipts
Michael Iseard's avatar
Michael Iseard committed
196
* *Added* - Invoices - PDFs now generated for each successful transaction and are available from the transactions table
197
* *Added* - Donor search bar to transactions
Michael Iseard's avatar
Michael Iseard committed
198
* *Fixed* - Input checks for API Key type
199

Michael Iseard's avatar
Michael Iseard committed
200
201
202
203
204
205
206
= 1.0.2 =
* *Added* - transactions table now shows record count per filter
* *Added* - return message now shows currency symbol
* *Fixed* - if log file cannot be written this no longer prevents plugin from working
* *Fixed* - export now only exports transaction in current view (all/live/test)
* *Fixed* - incorrect record count on transaction table

Michael Iseard's avatar
Michael Iseard committed
207
208
209
= 1.0.1 =
* *Added* - ability to export transactions
* *Fixed* - missing defaults from Kudos button block
Michael Iseard's avatar
Michael Iseard committed
210
* *Fixed* - missing Dutch translations
Michael Iseard's avatar
Michael Iseard committed
211

Michael Iseard's avatar
Michael Iseard committed
212
= 1.0 =
Michael Iseard's avatar
Michael Iseard committed
213
* Initial release