=== PeerPal Widget ===
Contributors: ppdevs
Tags: iframe, embed, chat, peerpal, PeerPal Messenger, peerpal-plugin, chat plugin, widget, PeerPal Widget
Requires at least: 3.0
Tested up to: 5.5
Requires PHP: 7.1.23
Stable tag: 1.0.3
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl.html

== shortcode ==
[peerpal color='blue' school='Demo' side='right' edge=25 bottom=25]

= PeerPal Widget parameters: =
* **color** - your school color or website color to blend our widget with your website;
* **school** - your school name in the PeerPal system (we will provide this to you, if you have not received one, please email pranav@peerpalschools.com);
* **side** - side of the webpage the chat widget displays: `[peerpal side="left"]`; by default side='right';
* **edge** - the chat widget's distance in pixels from the side parameter's (left/right) edge of the webpage : `[peerpal edge=125]`; by default edge=25;
* **bottom** - the chat widget's distance in pixels from the bottom of the webpage: `[peerpal bottom=50]`; by default bottom=25;

== Description ==

PeerPal is a platform that helps schools put their community front and center in the admissions process. More information on the PeerPal product can be found here: https://peerpalschools.com/#/.

Please view PeerPal’s privacy policy as well as the terms of service here: https://peerpalschools.com/#/terms

PeerPal Widget is a PeerPal product featuring a chat system,  which any school that is a PeerPal customer can embed into their website. PeerPal Widget is hosted on: (https://www.peerpalwidget.com/), and uses query parameters based on your school name and school color in our database to load relevant data for you. 

This official PeerPal Widget plugin makes it easier than ever for schools using Wordpress to implement. The PeerPal Widget shortcode is the replacement for the iframe html tag containing (https://www.peerpalwidget.com/) and allows you to customize the chat widget. For example, after you input your school name and color, you can have the widget render to the left with side=‘left’. Additionally, you can control how far off the edge of the screen the widget is by moving it up or pushing it down.

You may use PeerPal Widget shortcode on any page you desire, to embed the chat widget onto your desired webpage. 

**Important**: This plugin is meant for PeerPal customers only, please go to our website: www.peerpalschools.com to schedule a demo.

= General Support Guidelines =

if you are a PeerPal customer that needs support, please email devs@peerpalschools.com for support and further questions, please do not file a support ticket on the wordpress plugin page itself. We thank you for your cooperation and support.

== Installation ==

1. install and activate the plugin on the Plugins page
2. add shortcode `[peerpal color='blue' school='Demo' side='right' edge=25 bottom=25]` to page or post content. 
3. enjoy your newly initialized PeerPal chat widget!

== Screenshots ==

1. The shortcode should setup everything needed

== Changelog ==

= 1.0.0 =
* Initial release

= 1.0.1 =
* Bug fixes

= 1.0.2 =
* Bug fixes

= 1.0.3 =
* Bug fixes

 == Frequently Asked Questions ==

= Can anyone download and install this PeerPal Widget plugin? =

No! This widget is only meant to be used exclusively by PeerPal Customers. If you wish to learn more about PeerPal please visit: www.peerpalschools.com to schedule a demo. 

== Upgrade Notice ==

version 1.0.3 (20 August 2020) =
* Bug Fixes

version 1.0.2 (19 August 2020) =
* Bug Fixes

version 1.0.1 (28 July 2020) =
* Bug Fixes

version 1.0.0 (24 July 2020) =
* intial release

