Skip to content

docs: refresh README - #6

Merged
mrsarac merged 3 commits into
mainfrom
docs/readme-refresh
Oct 8, 2026
Merged

mrsarac merged 3 commits into
mainfrom
docs/readme-refresh

Conversation

@mrsarac

@mrsarac mrsarac commented Oct 7, 2026

Copy link
Copy Markdown
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

@mrsarac
mrsarac merged commit 840bd5d into main Oct 8, 2026
1 check failed
@mrsarac
mrsarac deleted the docs/readme-refresh branch October 8, 2026 07:45
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.

1 participant