=== YetiPoll Surveys ===
Contributors: yetipoll
Tags: surveys, rewards, points, mycred, gamipress
Requires at least: 5.6
Tested up to: 6.6
Requires PHP: 7.2
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Paid surveys for your members. They earn rewards on your site, you earn with every completed survey.

== Description ==

YetiPoll Surveys shows the YetiPoll survey wall on your site and adds every reward to the member who earned it.

* One shortcode: `[yetipoll]`
* Rewards go to a balance kept by this plugin, or to myCRED, GamiPress or WooCommerce Points and Rewards
* Every reward is checked to really come from YetiPoll, and is added once, however often it is sent
* A reward that is taken back after a quality check is taken back here too
* A sandbox mode with practice surveys, to try everything before real members see it

You need a free YetiPoll account: https://yetipoll.com

== Installation ==

1. In WordPress, open Plugins, Add New, Upload Plugin, choose the zip file and activate the plugin.
2. Open Settings, YetiPoll.
3. Copy the address shown under step 1 into the "Postback URL" field of your app in the YetiPoll dashboard.
4. Copy the four keys of your app from the YetiPoll dashboard into the settings and save.
5. Choose where rewards go.
6. Put `[yetipoll]` on a page.

To check it, press "Send a test completion" on the page of your app in the YetiPoll dashboard. The postback log should show it as delivered, with status code 200. A 403 means a wrong secret key, a 503 that the keys are missing or the points plugin you chose is switched off.

== Frequently Asked Questions ==

= Which user id does YetiPoll get? =

The WordPress user ID, a number. No name and no email address.

= How much is a reward worth here? =

One unit of the reward currency you set for your app in the YetiPoll dashboard is one point here. GamiPress and WooCommerce count whole points, so choose a currency without decimals for them.

= How do I try it without real surveys? =

Choose "Sandbox" under Mode. Members then see practice surveys, and practice rewards are added to accounts so you can watch the whole way work. Switch back to "Live" before real members use it.

= I use my own points system. =

Choose "A balance kept by this plugin" and hook into `yetipoll_rewarded`:

`add_action('yetipoll_rewarded', function ($user_id, $amount, $message) { /* $amount is negative when a reward is taken back */ }, 10, 3);`

= What is removed when I delete the plugin? =

The settings and the reward log. Balances members earned stay on their accounts.

== Changelog ==

= 1.0.0 =
* First release.
