Plugin Directory

Changeset 2067857


Ignore:
Timestamp:
04/12/2019 02:18:30 PM (7 years ago)
Author:
learnworlds
Message:

review and update description of the plugin

File:
1 edited

Legend:

Unmodified
Added
Removed
  • learnworlds-sso/trunk/readme.txt

    r2066566 r2067857  
    1313== Description ==
    1414
    15 This plugin allows the users of your WordPress website to login into your Learnworlds school, register a new learners account or even reset their password.
     15**The LearnWorlds SSO plugin connects a WordPress site with your LearnWorlds School for seamless browsing between them. It creates accounts, signs users in and keeps user login in both sites.**
    1616
    17 After installing this plugin, you would need to contact the LearnWorlds support team to provide you with API credentials and also configure the school to use your WordPress site for student authentication (SSO).
    18 The plugin comes with a shortcode and a widget that you may use to direct auto-signin your WordPress users to your school.
    19 An example shortcode might be: [learnworlds-sso-link url="http://myschool.learnworlds.com" text="Go to school"]
     17*This plugin requires a plan that includes SSO/API integration with LearnWorlds. You will need to contact the [LearnWorlds support](mailto:support@learnworlds.com) to receive the API credentials.*
    2018
    21 This plugin also supports **WooCommerce plugin**, if you have it enabled the "Use WooCommerce Account URLs" option will appear in our plugin's settings as well. This option, if enabled, allows your website to use the default account management pages that are installed by the WooCommerce plugin (tested with v3.5.6). If disabled, your users will be redirected to the default WordPress pages to log in, register or reset their password.
     19The LearnWorlds SSO plugin Improves the browsing experience of your students, by taking away the need to create new accounts or re-enter an email/password.
    2220
    23 Finally, every time a registered Learnworlds users changes their e-mail in their WordPress profile, the plugin updates that e-mail to the Learnworlds database as well.
     21**Easy Setup**
     22
     23You can now connect your website’s login with LearnWorlds for a seamless browsing experience without the need to have a technical team at your side. The plugin provides a widget and also a shortcode that you may use to create SSO links from your WordPress site to your LearnWorlds School.
     24An example of a shortcode might be:
     25```
     26[learnworlds-sso-link url="http://myschool.learnworlds.com" text="Go to school"]
     27```
     28
     29**WooCommerce Compatible**
     30
     31This plugin also supports the WooCommerce plugin and allows your website to use the default account management pages that are installed by the WooCommerce plugin.
     32
     33**Automatically Updates Email**
     34
     35Every time a registered Learnworlds users changes their e-mail in their WordPress profile, the plugin updates that e-mail to the Learnworlds database as well.
     36
     37**Support & Installation Help**
     38
     39LearnWorlds’ Customer Success is always here to help with the integration, questions and issues you might encounter along the way. Contact us at [LearnWorlds support](mailto:support@learnworlds.com).
     40
    2441
    2542== Frequently Asked Questions ==
     
    2744= In which LearnWorlds plan is SSO feature available  =
    2845
    29 SSO requires the use of the [LearnWorlds API](https://docs.learnworlds.com/) which is available for **LC (Learning Center) Plan** and above.
     46This plugin [requires a plan](http://www.learnworlds.com/pricing) -**Learning Center Plan** and above- that includes [SSO/API]((https://docs.learnworlds.com/)) integration with LearnWorlds.
    3047
    3148== Screenshots ==
     
    41581. Download the plugin using the Plugins`->`Add New page.
    42591. Activate the plugin by going to Plugins`->`Installed Plugins`->`Activate.
    43 1. [Contact LearnWorlds support team to get the credentials you need and configure your school for SSO.](https://support.learnworlds.com)
    44 1. Go to Settings`->`LearnWorlds SSO, enter the credentials and save the form.
    45 1. Use the shortcode and/or the widget where you need it to allow SSO to your Wordpress users
     601. Contact LearnWorlds’ [Customer Success team](https://support.learnworlds.com) to get the credentials you need and configure your school for SSO.
     611. Go to Settings`->`LearnWorlds SSO to enter the credentials and set up the plugin.
     621. Use the shortcode and/or the widget where you need it to allow SSO to your Wordpress users.
    4663
    4764== Changelog ==
Note: See TracChangeset for help on using the changeset viewer.