auth0 / express-jwt

connect/express middleware that validates a JsonWebToken (JWT) and set the req.user with the attributes
MIT License
4.49k stars 444 forks source link

Fix readme inconsistency #340

Open vitalii-bulyzhyn opened 9 months ago

vitalii-bulyzhyn commented 9 months ago

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

I noted little inconsistency in the readme docs. It's said that for migration to V6 instead of default export:

var jwt = require("express-jwt");

It should be:

var { expressjwt: jwt } = require("express-jwt");

So, I fixed that in 2 places in Readme

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

Checklist