Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved README structure #571

Merged
merged 2 commits into from
Apr 19, 2022
Merged

Improved README structure #571

merged 2 commits into from
Apr 19, 2022

Conversation

poovamraj
Copy link
Contributor

Note - need to review KeyProvider section based on the decision of #570

Changes

Restructured README in a more a consumable way
Added table of content

References

Refered to Auth0.Swift and nextjs-auth0 README

Testing

Checked the Preview for Markdown formatting

@poovamraj poovamraj requested a review from a team as a code owner April 1, 2022 10:08
jimmyjames
jimmyjames requested changes Apr 5, 2022
View reviewed changes
Copy link
Contributor

@jimmyjames jimmyjames left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also update the info about the available methods on the Claim types as needed, as well as review and update any docs regarding Date-based claim values to demonstrate Instant support, while we're here.

@jimmyjames jimmyjames added this to the v4-Beta milestone Apr 7, 2022
jimmyjames
jimmyjames approved these changes Apr 19, 2022
View reviewed changes
Copy link
Contributor

@jimmyjames jimmyjames left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good. I'll make another pass through the README for any additional improvement oppoortunities.

@poovamraj poovamraj merged commit 2d0f7bc into v4-dev Apr 19, 2022
@poovamraj poovamraj modified the milestones: v4-Beta, 4.0.0-beta.0 May 6, 2022
@poovamraj poovamraj mentioned this pull request May 6, 2022
Merged
@jimmyjames jimmyjames deleted the improve-readme branch October 15, 2022 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jimmyjames jimmyjames jimmyjames approved these changes

Assignees
No one assigned
Labels
CH: Added review:medium Medium review
Projects
None yet
Milestone
4.0.0-beta.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@poovamraj @jimmyjames