diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ceadd78 --- /dev/null +++ b/readme.md @@ -0,0 +1,13 @@ +# BU Liaison Inquiry # +Inquiry form for Liaison Inc.'s SpectrumEMP enrollment CRM +## Description +This Wordpress plugin provides an inquiry form for prospective students. It uses the SpectrumEMP API to get the form parameters from Liaison, and submit the form data back to Liaison. +## Usage +### Admin +The plugin provides an option page in the Wordpress admin, under the main `Settings` menu called `Liaison API Keys`. Enter the API Key and Client ID provided by Liaison for the relevant account here. +### Inquiry Form shortcode +Once the API Key and Client ID have been set, the inquiry form can be placed anywhere in the site by using the following shortcode: + +`[liaison_inquiry_form]` + +When the page or post is displayed, the shortcode will be replaced by the Liaison iquiry form. Prospective students can fill out the form and submit it directly from the Wordpress site, and will be redirected to their personal URL on the Spectrum EMP site. \ No newline at end of file