From 562b9dc018360ae536ded3372dbe96536469d4ab Mon Sep 17 00:00:00 2001 From: Alec Larson <1925840+aleclarson@users.noreply.github.com> Date: Wed, 6 Nov 2024 19:50:34 -0500 Subject: [PATCH] docs: recommend version pinning --- readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index a47d9f7..f5efefb 100644 --- a/readme.md +++ b/readme.md @@ -18,7 +18,10 @@ ast.stmts // => [{ stmt: SelectStmt, stmt_len: 8 }, { stmt: SelectStmt, stmt_loc pnpm add @pg-nano/pg-parser ``` -The major and minor version of this package is meant to be aligned with the supported PostgreSQL major and minor version. Older and newer versions may be compatible, but this is not guaranteed. +The major and minor version of this package is meant to be aligned with the supported PostgreSQL major and minor version. Older and newer versions of PostgreSQL may be compatible, but this is not guaranteed. + +> [!WARNING] +> This package may be improved in ways that break your type guards. You'll probably want to pin to a specific version to avoid unexpected type changes. Upon install, the pre-compiled binary for your operating system and architecture will be pulled from GitHub Releases.