Added readme, improved some comments

admin/openid-connect-generic-settings.php

@@ -33,9 +33,9 @@ class OpenID_Connect_Generic_Settings {
      * 
      * - title
      * - description
-     * - type ( checkbox | text )
-     * - section ( settings/option page section )
-     * - example (optional)
+     * - type ( checkbox | text | select )
+     * - section - settings/option page section ( client_settings | authorization_settings )
+     * - example (optional example will appear beneath description and be wrapped in <code>)
      */
     $this->settings_fields = array(
       'login_type' => array(

openid-connect-generic.php

@@ -1,11 +1,11 @@
 <?php
 /*
 Plugin Name: OpenID Connect - Generic Client
-Plugin URI: 
+Plugin URI: https://github.com/daggerhart/openid-connect-generic
 Description:  Connect to an OpenID Connect identity provider with Authorization Code Flow
 Version: 2.0
 Author: daggerhart
-Author URI: 
+Author URI: http://www.daggerhart.com
 License: GPLv2 Copyright (c) 2015 daggerhart
 */
 

readme.txt

@@ -0,0 +1,46 @@
+=== OpenID Connect Generic Client ===
+Contributors: daggerhart
+Donate link: http://www.daggerhart.com/
+Tags: security, login, oauth2, openidconnect, apps, authentication, autologin, sso 
+Requires at least: 3.0.1
+Tested up to: 4.2.2
+Stable tag: trunk
+License: GPLv2 or later
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
+
+A simple client that provides SSO or opt-in authentication against a generic OAuth2 Server implementation.
+
+== Description ==
+
+This plugin allows to authenticate users against OpenID Connect OAuth2 API with Authorization Code Flow.
+Once installed, it can be configured to automatically authenticate users (SSO), or provide a "Login with OpenID Connect"
+button on the login form. After consent has been obtained, an exiting user is automatically logged into WordPress, while 
+new users are created in WordPress database.
+
+Much of the documentation can be found on the Settings > OpenID Connect Generic dashboard page.
+
+Heavily based on the plugin provided by shirounagi - https://wordpress.org/plugins/generic-openid-connect/ but 
+has been completely rewritten to provide a bit more flexibility in development going forward.
+
+== Installation ==
+
+1. Upload to the `/wp-content/plugins/` directory
+1. Activate the plugin
+1. Visit Settings > OpenID Connect and configure to meet your needs
+
+== Frequently Asked Questions ==
+
+= What is the client's Redirect URI? =
+
+Most OAuth2 servers will require whitelisting a set of redirect URIs for security purposes. The Redirect URI provided
+by this client is like so:  https://example.com/wp-admin/admin-ajax.php?action=openid-connect-authorize
+
+Replace `example.com` with your domain name and path to WordPress.
+
+
+== Changelog ==
+
+= 2.0 =
+
+Complete rewrite of another plugin
+