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

Flesh out documentation #8

Open
ulrikstrid opened this issue Jan 18, 2020 · 1 comment
Open

Flesh out documentation #8

ulrikstrid opened this issue Jan 18, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ulrikstrid
Copy link
Owner

No description provided.

@ulrikstrid ulrikstrid added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 20, 2020
@dangdennis
Copy link

What format would you like documentation in?

While it wasn't terrible to dig through the types and tests to understand how to use the library, I'm sure many would find it helpful to have early pointers to important apis. See link where I put together a small set of steps to parse a JWKS, find the correct key, and validate my ES256-signed JWT. I can put a series of mini guides together onto the readme.

The readme can follow how auth0 does it https://github.com/auth0/node-jsonwebtoken.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ulrikstrid @dangdennis