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.

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

Merged
merged 2 commits into from
Feb 25, 2021
Merged

docs: Update README #93

merged 2 commits into from
Feb 25, 2021

Conversation

craigshoemaker
Copy link
Collaborator

  • 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.
Copy link
Member

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.

Copy link
Collaborator Author

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:
Copy link
Member

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

Copy link
Collaborator Author

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?

Copy link
Collaborator Author

@craigshoemaker craigshoemaker left a 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.

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@manekinekko manekinekko merged commit 6a837db into Azure:main Feb 25, 2021
@manekinekko
Copy link
Member

Thank you @craigshoemaker 🎉

@craigshoemaker craigshoemaker deleted the patch-1 branch February 26, 2021 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants