Skip to content

docs: add the repository README and CONTRIBUTING - #9

Merged
ryanleecode merged 1 commit into
mainfrom
docs-root-readme
Nov 21, 2026
Merged

ryanleecode merged 1 commit into
mainfrom
docs-root-readme

Conversation

@systemfsoftware-maker

Copy link
Copy Markdown

Summary

The repository root now has a README, so the GitHub landing page describes the library instead of showing nothing — the package README had moved under packages/ with nothing at root to replace it.

The new README.md pitches the library, shows a TimescaleDB hypertable declared beside a Drizzle table, gives install with the drizzle-orm, drizzle-kit and Node floors, carries the coverage table pointing into the package reference, states the tested versions, and links the package README as the full reference. Developer setup, the checks and the integration-test descriptions move to a new CONTRIBUTING.md and out of packages/drizzle-pg-extras/README.md, which is the npm page and now carries the library reference only.

Docs only: no changeset. pnpm format:check passes.

@ryanleecode
ryanleecode merged commit af8d3de into main Nov 21, 2026
13 checks passed
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.

2 participants