Readme updates #392
Readme updates #392
Conversation
joshcanhelp
commented
Feb 8, 2018
joshcanhelp
commented
- Removed all duplicate information from README.md, updated WP.org readme.txt
- Removed incomplete hook documentation from README.md - docs PR
- General improvements in quality, wording
- Removing outdated screenshot
…umentation (moving to auth0/docs) and point to more relevant documents
|
Pending auth0/docs#5707 |
| @@ -1,110 +1,31 @@ | |||
|  | |||
|
|
|||
| Wordpress Plugin for Auth0 | |||
| Login by Auth0 | |||
There was a problem hiding this comment.
This is for consistency from elsewhere?
There was a problem hiding this comment.
@cocojoe - That's the name on WordPress.org and in the plugin
| ## Implicit Flow | ||
|
|
||
| There are cases where the server is behind a firewall and does not have access to internet (or at least, can't reach the Auth0 servers). In those cases, you can enable the Auth0 Implicit Flow in the advanced settings of the Auth0 Settings page. | ||
| [Please see the Installation page on auth0.com/docs](https://auth0.com/docs/cms/wordpress/installation) |
There was a problem hiding this comment.
Does this also mention that you should set your client type in dashboard to SPA?
There was a problem hiding this comment.
@cocojoe - I'm removing the reference to Implicit here, not related to the added line below
| ## Contributions | ||
|
|
||
| All PR should be done towards the `dev` branch. | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
I think there is no harm in duplicating core information like install, if you discover the repo somehow then the README should be enough to get started without having to go off elsewhere. The other repos are like this.
There was a problem hiding this comment.
@cocojoe - The other repos like SDKs? The problem comparing those is that the repo is the starting point for those whereas wp.org/plugins is where most people will start with this plugin. All of the "how to use this plugin" stuff should be on docs, where we have much better control over presentation/content. All of the basic stuff and "why to use this" should be in the WP.org readme. The repo readme is probably best as a list of links, for the most part.
What I really want to avoid, though, is maintain the same steps/info in 2 or more different places.
