From 28ad4873d3817802074177603ff9cefbb4dc9449 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Sat, 14 Sep 2019 20:45:50 -0500 Subject: [PATCH] Final v4 doc changes --- CHANGELOG.md | 7 ++++--- README.md | 6 +----- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ee1a785..f5a2ee16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ -# 4.0.0 (Release candidate) +# 4.0.0 (September 14, 2019) -v4 is a major release with many significant changes. The most significant are included below. +v4 is a major release with many significant changes some of which are breaking changes. The most significant are +included below. * Simplified establishing a connection with a connection string. * All potentially blocking operations now require a context.Context. The non-context aware functions have been removed. @@ -11,7 +12,7 @@ v4 is a major release with many significant changes. The most significant are in * `Rows` and `Tx` are now interfaces. * The connection pool as been decoupled from pgx and is now a separate, included package (github.com/jackc/pgx/v4/pgxpool). * pgtype has been spun off to a separate package (github.com/jackc/pgtype). -* pgproto3 has been spun off to a separate package (github.com/jackc/pgproto3). +* pgproto3 has been spun off to a separate package (github.com/jackc/pgproto3/v2). * Logical replication support has been spun off to a separate package (github.com/jackc/pglogrepl). * Lower level PostgreSQL functionality is now implemented in a separate package (github.com/jackc/pgconn). * Tests are now configured with environment variables. diff --git a/README.md b/README.md index cf3053e9..1d011669 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,6 @@ The toolkit part is a related set of packages that implement PostgreSQL function and type mapping between PostgreSQL and Go. These underlying packages can be used to implement alternative drivers, proxies, load balancers, logical replication clients, etc. -## v4 - -This is the `v4` branch. `v4` is in release candidate state but is not officially released. - ## Example Usage ```go @@ -179,4 +175,4 @@ In addition there are tests specific for PgBouncer that will be run if the `PGX_ ## Version Policy -pgx follows semantic versioning for the documented public API on stable releases. This is the prerelease of `v4`. Branch `v3` is the latest stable release. `master` can contain new features or behavior that will change or be removed before being merged to the stable `v3` branch (in practice, this occurs very rarely). +pgx follows semantic versioning for the documented public API on stable releases. `v4` is the latest stable major version.