Add version notice

2017-06-05 09:15:00 -05:00
parent 9bd22f689a
commit 6b2cb6800e
1 changed files with 12 additions and 0 deletions
@@ -2,6 +2,18 @@

 # Pgx

+## Master Branch
+
+This is the `master` branch which tracks the stable release of the current
+version. At the moment this is `v2`. The `v3` branch which is currently in beta.
+General release is planned for July. `v3` is considered to be stable in the
+sense of lack of known bugs, but the API is not considered stable until general
+release. No further changes are planned, but the beta process may surface
+desirable changes. If possible API changes are acceptable, then `v3` is the
+recommented branch for new development. Regardless, please lock to the `v2` or
+`v3` branch as when `v3` is released breaking changes will be applied to the
+master branch.
+
 Pgx is a pure Go database connection library designed specifically for
 PostgreSQL. Pgx is different from other drivers such as
 [pq](http://godoc.org/github.com/lib/pq) because, while it can operate as a