Add package READMEs and MIT licenses

[gentamura]

Summary

• add package-level README files for @listee/api, @listee/auth, @listee/db, and @listee/types
• declare the MIT license in each package.json so npm shows correct metadata

Testing

• not run (docs and metadata only)

Summary by CodeRabbit

• Documentation

  • Expanded Release Process section with detailed workflow steps and publishing requirements
  • Added comprehensive package documentation for @listee/api, @listee/auth, @listee/db, and @listee/types packages

• Chores

  • Added MIT license field to package metadata

[coderabbitai]

Walkthrough

The PR expands the root README's Release Process section with detailed workflow steps for package publishing, and adds new README files to four packages (api, auth, db, types) along with MIT license metadata to their respective package.json manifests.

Changes

Cohort / File(s)	Summary
Root Release Process Documentation README.md	Expanded Release Process section with multi-step workflow (steps 1–4) for creating changesets, CI flows, publishing approvals, and version verification. Added "Trusted Publishing requirements" subsection with publishConfig JSON snippet and npm token handling notes.
Package Documentation packages/api/README.md, packages/auth/README.md, packages/db/README.md, packages/types/README.md	Added new READMEs for each package describing installation, features, quick-start examples, development commands, and licensing.
Package License Metadata packages/api/package.json, packages/auth/package.json, packages/db/package.json, packages/types/package.json	Added "license": "MIT" field to each package manifest.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Prepare v0.1.1 release #8 — Modifies package manifests and release-related files (package.json and changelogs) across the same packages.
• Declare publish config for npm provenance #17 — Adds publishConfig metadata for npm provenance; both PRs update package publishing metadata and release/publish workflow documentation.

Poem

🐰 Four packages now sport their README crown,
With MIT licenses pinned right down,
Release workflows clear, step by step,
Documentation's dance—what a prep!
hops away with satisfaction ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Add package READMEs and MIT licenses" accurately captures the primary objectives of the changeset. The PR adds new README.md files for four packages (@listee/api, @listee/auth, @listee/db, and @listee/types) and declares MIT license fields in their corresponding package.json files. The title is concise, specific, and clearly communicates what was changed without being overly broad or vague. While the PR also includes an expansion of the root README.md Release Process section, this is a secondary change compared to the main focus on package-level documentation and metadata.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/add-repo-fields

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c2176c and ea8dd81.

📒 Files selected for processing (9)

• README.md (1 hunks)
• packages/api/README.md (1 hunks)
• packages/api/package.json (1 hunks)
• packages/auth/README.md (1 hunks)
• packages/auth/package.json (1 hunks)
• packages/db/README.md (1 hunks)
• packages/db/package.json (1 hunks)
• packages/types/README.md (1 hunks)
• packages/types/package.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

packages/*/package.json

📄 CodeRabbit inference engine (AGENTS.md)

Reference shared dependencies via the "catalog:" protocol in package manifests

Files:

• packages/auth/package.json
• packages/db/package.json
• packages/types/package.json
• packages/api/package.json

🧠 Learnings (2)

📚 Learning: 2025-10-02T12:40:33.718Z

Learnt from: CR
PR: listee-dev/listee-libs#0
File: AGENTS.md:0-0
Timestamp: 2025-10-02T12:40:33.718Z
Learning: Applies to packages/auth/src/authentication/**/*.{ts,tsx} : Place runtime-specific authentication adapters under packages/auth/src/authentication/ (e.g., header.ts, supabase.ts, shared utilities, errors.ts)

Applied to files:

• packages/auth/README.md

📚 Learning: 2025-10-02T12:40:33.718Z

Learnt from: CR
PR: listee-dev/listee-libs#0
File: AGENTS.md:0-0
Timestamp: 2025-10-02T12:40:33.718Z
Learning: Applies to packages/auth/src/authentication/**/*.ts : Extend Supabase JWT verification (createSupabaseAuthentication using .well-known/jwks.json) only via dedicated modules to keep caching and claim validation centralized

Applied to files:

• packages/auth/README.md

🪛 LanguageTool

packages/auth/README.md

[grammar] ~35-~35: Use a hyphen to join words.
Context: ...l adapters and tests demonstrating error handling scenarios. ## Development - B...

(QB_NEW_EN_HYPHEN)

packages/types/README.md

[grammar] ~35-~35: Use a hyphen to join words.
Context: ...o dist/ - Execute bun test or higher level tests in dependent packages to ens...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (11)

packages/auth/README.md (1)

1-45: README structure and content are solid.

The documentation clearly covers installation, features, quick start, and development commands. The reference to src/authentication/ aligns well with the codebase organization for adapter placement. Based on learnings

packages/types/README.md (1)

1-39: README clearly documents the package scope and usage.

The documentation effectively communicates that the package ships only type declarations, includes a practical usage example, and describes the development workflow.

packages/api/README.md (1)

1-50: README is well-structured and provides clear guidance.

The documentation accurately describes the package's purpose, features, and usage patterns. The quick start example effectively demonstrates the wiring of queries and routes, and the reference to testing via factories aligns with the testability patterns implied by the root README architecture guidelines.

README.md (1)

61-74: Release Process section is comprehensive and actionable.

The expanded documentation clearly walks through the four-step workflow (changeset → PR → version PR → publish) and includes explicit Trusted Publishing requirements with the correct publishConfig and repository structure. This aligns well with the license metadata and publishConfig entries being added to package manifests in this PR.

packages/db/README.md (1)

1-45: README clearly documents the database layer utilities.

The documentation covers the package's main features (connection caching, RLS helpers, schema exports), includes a practical quick-start example, and explicitly calls out the POSTGRES_URL requirement. The connection reuse behavior is properly documented.

packages/types/package.json (1)

9-9: License metadata correctly added.

The MIT license declaration aligns with the licensing policy established across the monorepo packages and is properly positioned in the manifest.

packages/auth/package.json (2)

9-9: License metadata correctly added.

The MIT license declaration is properly placed and aligns with other package manifests in the monorepo.

---

25-29: Dependency declarations follow the catalog protocol correctly.

The @listee/* workspace dependencies and jose library use the correct "catalog:" protocol as per coding guidelines.

packages/db/package.json (2)

9-9: License metadata correctly added.

The MIT license declaration is properly placed and consistent with the licensing approach across the monorepo.

---

25-28: Dependency declarations follow the catalog protocol correctly.

The dependencies use the correct "catalog:" protocol for shared dependencies (drizzle-orm, postgres) as per coding guidelines.

packages/api/package.json (1)

9-9: License metadata added correctly.

The addition of the MIT license field is clean and straightforward. The existing dependencies are already properly configured per the coding guidelines: external shared dependencies use "catalog:" (line 29), and monorepo packages use "workspace:*" (lines 26–28).