read/AGENTS.md

AGENTS.md

Project notes for coding agents working in this repo.

Commands

• Install: pnpm install
• Typecheck (acts as tests): pnpm test
• Build: pnpm build
• Dev: pnpm dev

Conventions

• Use 2-space indentation.
• Keep changes scoped: one logical change per commit.
• Commit messages: concise, one line, sentence case. No emojis. No "Co-Authored-By".
• Update CHANGELOG.md for user-visible changes (topmost entry).

Repo Layout

• src/App.tsx is the main app shell.
• src/components/ holds UI components and modals.
• src/lib/ holds parsing + logic:
  • src/lib/epub.ts for EPUB parsing and optional Open Library metadata.
  • src/lib/pdf.ts for PDF text extraction.
  • src/lib/storage.ts for localStorage + iOS/fullscreen helpers.
  • src/lib/reading.ts for RSVP timing/ORP helpers.
• src/vendor/pdfjs/ vendors PDF.js ESM + worker for offline-friendly PDF parsing (see LICENSE in that folder).