Skip to content

Streamline OSS README #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benvinegar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Streamline OSS README #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
- `src/drizzle-compat.ts` — Drizzle SQL chunk inspection helpers used by strict validation.
- `tests/unit/` — fake-builder Vitest suites grouped by behavior: select guardrails, mutation guardrails, relational wrappers, API surface, custom rules/errors, and Drizzle compatibility helpers.
- `tests/integration/` — real-driver integration suites for Postgres/PGlite and SQLite.
- `README.md` — OSS-facing package documentation.
- `README.md` — OSS-facing getting-started and project overview.
- `docs/guide.md` — deeper usage guide, security model, and RLS/dialect notes.
- `docs/api.md` — public API reference.
- `CHANGELOG.md` — user-visible change log.

## Working rules
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ All notable user-visible changes to this project are documented in this file.

### Changed

- Restructure README as a shorter getting-started overview and move deeper usage/API material into `docs/`.

### Fixed

## [0.10.0] - 2026-06-30
Expand Down
Loading
Loading