Auth0.Android icon indicating copy to clipboard operation
Auth0.Android copied to clipboard

Published 20 hours ago • verified publisher icon auth0

[SDK-3676] Readme redesign

Open poovamraj opened this issue 2 years ago • 3 comments

Changes

  • Changed to new README design
  • Moved FAQ and EXAMPLES to separate page to keep the main README concise and also have enough headers to parse through information easier in respective pages

poovamraj avatar Oct 13 '22 19:10 poovamraj

It looks like the build is failing due to the ship orb config. You can see java-jwt for the ship config there, should be fairly similar.

jimmyjames avatar Oct 15 '22 01:10 jimmyjames

I second @jimmyjames' comment about the length, according to the guide everything that's basically not login should be moved out to EXAMPLES or FAQ where possible.

Also this PR does not include the "Configure Auth0" section.

stevehobbsdev avatar Oct 18 '22 10:10 stevehobbsdev

@jimmyjames @stevehobbsdev I have updated the README from the comments. I haven't changed a few things and providing context here

  1. Still using emojis instead of Github markdown syntax as emojis are unicode encoded and can be rendered in more places than github syntax. We already had issues in other repos where doc generators didn't work well with Github syntax

  2. We have moved Proguard, Unit testing and Secure credential manager details to EXAMPLES but Credentials Manager details are still in README as I feel it is a basic feature of the SDK which should be noted in the front.

  3. We haven't added "Configure Auth0" section as they can be found in Quickstart and README can go into the nuances of the SDK.

poovamraj avatar Oct 20 '22 12:10 poovamraj