diff --git a/README.md b/README.md index 40c7873..9f49d83 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # NodeBB OAuth2 Multiple Client SSO -This NodeBB plugin allows you to configure logins to multiple configurable OAuth2 endpoints, via the admin backend. \ No newline at end of file +This NodeBB plugin allows you to configure logins to multiple configurable OAuth2 endpoints, via the admin backend. + +## Caveat + +Different OAuth2 providers adhere to the standard differently. +This plugin is tested primarily against the following providers: + +* [Auth0 by Okta](//auth0.com) +* [Okta](//www.okta.com/) + +Support for other OAuth2 providers is _explicitly not guaranteed_. +If you'd like to help this plugin play nice with other providers, please +[open an issue](https://github.com/NodeBB/nodebb-plugin-sso-oauth2-multiple/issues). + +## Screenshots + +![OAuth2 Strategy Editing](./screenshots/configure.png) \ No newline at end of file diff --git a/screenshots/configure.png b/screenshots/configure.png new file mode 100644 index 0000000..b41bce9 Binary files /dev/null and b/screenshots/configure.png differ