docs: expand README with a high-level usage guide - #62
Merged
Conversation
Grow the README from a stub into a high-level guide, in plain English: what pgkit is, the problems it solves, install/connect, the low-level query-builder path and the high-level Table[T] CRUD path, db tag semantics (omitempty/omitzero), pagination (offset + cursor), transactions, and extras (soft delete, timestamps, streaming, job queues, tracing). Keeps the original badges, library links, go get line, tests reference, and MIT license section; only adds around them. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Restore the original "lightweight PostgreSQL sugar combining the use of.." line and its library bullet list verbatim as the lead, instead of the reworded intro. Keep only the additive "not an ORM" clarification below it, and drop the duplicate library list from the "What pgkit adds" section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Grows the README from a short stub into a plain-English guide to the library.
Sections added:
Exec/GetAll/GetOne/RawQuery) and the high-levelTable[T]CRUDomitemptyvsomitzerotag semanticsLockForUpdate, tracing)Preserved
The original badges, library links,
go getline,tests/pgkit_test.goreference, and the[MIT](./LICENSE)section are all kept — the new content is added around them, nothing removed.Notes
Docs-only; no code changes. Every code snippet was checked against the current API (
Connect,Table[T],NewPage,WithMode,WithTx,RawQuery(...).Build(...),GetAll/GetOne,ErrNoRows).🤖 Generated with Claude Code