Skip to content

Streamline OSS README#39

Open
benvinegar wants to merge 1 commit into
mainfrom
docs/clean-up-readme
Open

Streamline OSS README#39
benvinegar wants to merge 1 commit into
mainfrom
docs/clean-up-readme

Conversation

@benvinegar

Copy link
Copy Markdown
Member

Summary

  • Rewrite README as a shorter getting-started and project overview
  • Move deeper usage, security model, RLS comparison, dialect notes, and API details into docs/guide.md and docs/api.md
  • Add CI badge and clearer Performance and Testing sections
  • Include docs/ and benchmark release docs in the published package
  • Update AGENTS and changelog references for the new docs layout

Validation

  • pnpm format:check
  • pnpm lint
  • pnpm typecheck
  • pnpm test
  • pnpm coverage
  • pnpm build
  • npm pack --dry-run

This PR description was generated by Pi using OpenAI GPT-5 Codex

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