docs(readme): registry install and current public API (CL-8775) - #28
Merged
Merged
Conversation
Registry install (npm/pnpm/yarn/bun) is the primary path. Document the current public API. Fixes CL-8775.
Use Quickstart / How it works / Development / License instead of Install / Use / Full example / Contributing.
…CTURE link (CL-8775)
TheGreatAxios
force-pushed
the
cl-8775-readme-mailbox
branch
from
September 22, 2026 04:08
f9bd922 to
dc1bf66
Compare
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 README's Quickstart to model real production usage instead of self-contained fakes.
mountMailboxon a Hono app, wrapped in oneinstallMailbox(app, { databaseUrl, resolvePrincipal?, senderAddressFor, deliver })function that owns the mount, matching how a hub mounts it under its own tenant prefix (/api/tenants/:tenantId/mailbox).senderAddressForanddeliverare typed asMountMailboxOpts["senderAddressFor"]/MountMailboxOpts["deliver"]parameters the host supplies — no invented.exampleaddress, noconsole.logstanding in for delivery. Prose explains what a real host answers with (a directory lookup for the address, the host's own request pipeline for delivery) without fabricating an implementation.createMailboxPersistinwrapPersistMail(db, bus, { upstream, authorizeSender }), again taking the package's ownAuthorizeMailboxSender/MailboxPersistArgs-typedupstreamas host-supplied parameters — no inventedsender_directoryortransport_logtables.src/exports.Verification
README-only. Both
tsfences copied into scratch files and typechecked against this repo's owntsc(via a temporarypathsmapping tosrc/index.ts); zero errors. Scratch files were not committed.