Repository navigation
docs: refresh README - #6
Merged
Merged
Conversation
mrsarac
commented
Oct 7, 2026
Member
- Restructure README into Why / Quick start / How it works / Status / License, with a version badge and a small mermaid diagram
- Install instructions now use the GitHub source (the package is not published to a registry; the committed dist/ makes this work)
- Replace the hardcoded Logto hostname in the example with a placeholder
- Add an export table per entry point and notes on guest mode, user sync and logging
- Status section lists the failing tests and type errors on main, the env fallback to a fixed Logto instance, and that optionalAuthMiddleware is not optional yet
- Remove the internal dogfooding section
- License section notes that LICENSE is missing (package.json says MIT)
- Ignore agent tooling files in .gitignore
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
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.