Skip to content

docs: rewrite README to match the current generator - #9

Closed
roderm wants to merge 2 commits into
masterfrom
docs/update-readme
Closed

roderm wants to merge 2 commits into
masterfrom
docs/update-readme

Conversation

@roderm

@roderm roderm commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The README described a plugin surface that no longer exists (crud:[C,R,D] table option, sqlgen/sqlgen.proto extension import, ad-hoc pg filter helpers) — CLAUDE.md already flags the old usage example as stale.
  • Rewrites it around the actual schema/scanner/query plugins, the real sqlmap/v1 proto3 annotations, plugins= generation parameter, BSR remote-plugin usage, and a usage example drawn from the e2e test (migration.New/m.Create, query.Conn, Load<Message>).
  • Updates the roadmap to reflect what's actually done (migrations, eager-loading queries, subtypes, multi-dialect, BSR publish) vs. planned (filtrify-based runtime filters).

Test plan

  • Docs-only change; no code touched. Reviewed generator source (generator.go, pkg/query, pkg/migration, testdata protos, e2e test, golden files) to verify every claim/example in the new README against current behavior.

🤖 Generated with Claude Code

roderm and others added 2 commits August 30, 2026 18:23
The old README described a crud:[C,R,D] table option, sqlgen/sqlgen.proto
extension imports, and a filter API that no longer exist. Replace it with the
actual schema/scanner/query plugins, sqlmap/v1 annotations, real usage drawn
from the e2e test, and an accurate roadmap.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@roderm

roderm commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator Author

Wrong target repo, recreating against snaerverk/protoc-gen-go-sqlmap.

@roderm roderm closed this Sep 2, 2026
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