Skip to content

docs(readme): add IMAP packages to package list and status table#74

Merged
ssilvius merged 1 commit intomainfrom
chore/readme-imap-packages
Apr 11, 2026
Merged

docs(readme): add IMAP packages to package list and status table#74
ssilvius merged 1 commit intomainfrom
chore/readme-imap-packages

Conversation

@ssilvius
Copy link
Copy Markdown
Contributor

Summary

README's package list and status table were 6 packages but the repo ships 9. The three IMAP packages (@rafters/mail-imap, @rafters/mail-imap-cloudflare, @rafters/mail-imap-server) landed in #60-#71 but never made it into the README. npm consumers read this page first -- the packages need to be visible where users actually look.

Changes

  • Package list block: adds the three IMAP packages with one-line descriptions.
  • Status table: adds a row per IMAP package.
  • New `## IMAP` section between Quick Start and Status: explains the bring-your-own-auth posture, lists the two runtimes side by side (DO hibernation vs Node TCP), and describes what the protocol layer covers (commands, session, UID map, adapter interfaces).
  • Test count updated: 289 -> 609 across 37 files.

Test plan

  • `pnpm format:check README.md` -- clean
  • Diff is README-only, no other files touched
  • `legion-simplify` gate: clean

…tus table

The README's package list and status table were out of date after the IMAP
packages landed (#60-#71). npm consumers land here first -- the three IMAP
packages need to be visible where a potential user is actually looking.

Adds:
- @rafters/mail-imap -- transport-agnostic IMAP4rev1 protocol layer
- @rafters/mail-imap-cloudflare -- Durable Object runtime with hibernation
- @rafters/mail-imap-server -- Node TCP/TLS runtime

Also adds a short IMAP section above Status that explains the
bring-your-own-auth posture and lists the two runtimes side by side.
Test count updated: 289 -> 609 across 37 files.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ssilvius ssilvius merged commit bce6d01 into main Apr 11, 2026
1 check passed
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