Misleading documentation for startRedirectPath

fastify / fastify-oauth2

Enable to perform login using oauth2 protocol

MIT License

243 stars 69 forks source link

Misleading documentation for startRedirectPath #262

Closed johnkmzhou closed 1 week ago

johnkmzhou commented 4 weeks ago

Prerequisites

[X] I have written a descriptive issue title
[X] I have searched existing issues to ensure the issue has not already been raised

Issue

In the README, under Usage, running the code will result in an error that states Method 'GET' already declared for route '/login/facebook'. The documentation should mention that the /login/facebook route only needs to be created if startRedirectPath has not been provided.

mcollina commented 4 weeks ago

Thanks for reporting! Would you like to send a Pull Request to address this issue? Remember to add unit tests.