-
Notifications
You must be signed in to change notification settings - Fork 125
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.
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
docs: Update README #93
Conversation
craigshoemaker
commented
Feb 25, 2021
- Clarify auth emulation port
- General text clean up
- Clarify auth emulation port - General text clean up
readme.md
Outdated
When requesting `./auth/login/<provider>`, you will access a local authentication UI allowing you to set fake user information. | ||
The CLI allows you to mock and read authentication & authorization credentials. | ||
|
||
> **NOTE:** You must use port `4280` to access the authentication UI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While 4280
is the default port, users may provide a different port using the --port
option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll update the note to say that.
readme.md
Outdated
|
||
When requesting `http://localhost:4280/.auth/login/<PROVIDER_NAME>`, you have access a local authentication UI allowing you to set fake user information. | ||
|
||
Provider names available include: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
User may also use their own auth providers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay - maybe just take this section out then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated text based on review feedback.
Thank you @craigshoemaker 🎉 |