Repository navigation
Simplify usage documentation and prepare 0.1.1 - #6
Merged
Merged
Conversation
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.
The README buried the first steps under complete setup walkthroughs. Replace those walkthroughs with a table linking runnable repository examples, keep the minimal test and Testcontainers pairing prominent, and move detailed configuration to docs/usage.md. Remove the database coverage section and explain that the lifecycle delegates transaction handling to the configured database client adapter.
Bump the package and lockfile to 0.1.1, update the changelog and release commands, and preserve the repository-only example packaging boundary. No runtime API changes.
Validation: package build and installed-package checks passed before the final documentation-only refinement, including optional dependency independence, ESM/CommonJS runtime and declarations, and the SQLite example. Checked repository links and anchors, matching root/package READMEs, and a frozen lockfile install. CI runs the complete checks on the final commit. This PR does not publish the package.