docs: rewrite README for discoverability - #116
Merged
Merged
Conversation
Replace the 23-line stub (still pointing at einari/ingress) with an accurate README: what AuthProxy is (YARP-based authentication and multi-tenancy gateway for ASP.NET Core), the edge concerns it handles, a container + Aspire quickstart derived from the documentation, how it pairs with Arc, and the Cratis ecosystem section. Fix badge targets to Cratis/AuthProxy and the local documentation link.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the 23-line README stub into an accurate, discoverable README, sourced entirely from this repository's source tree and documentation:
Tenant-IDheader), identity enrichment via/.cratis/me, invites/registration/lobby onboarding, credential linking, admission, trusted proxies, and the management listener.Cratis.AuthProxy.AspireAppHost snippet) derived fromDocumentation/.einari/ingressand the brokenDocumentation/index.mdlink.No source code changes; documentation only.