Document tree structure for github README
authorCraig Ringer <craig@2ndquadrant.com>
Thu, 26 Mar 2015 02:40:07 +0000 (10:40 +0800)
committerCraig Ringer <craig@2ndquadrant.com>
Thu, 26 Mar 2015 02:47:50 +0000 (10:47 +0800)
README.bdr

index 19e01dd0d9827c33b8b4e0ad8c0b5688c1d61068..57e7f64f265dec84815658c076d8160e1c14aeea 100644 (file)
@@ -1,8 +1,18 @@
-See https://wiki.postgresql.org/wiki/BDR_User_Guide for documentation on the
-installation and use of BDR.
+See http://2ndquadrant.com/BDR and http://bdr-project.org/docs/ for
+documentation on the installation and use of BDR.
 
 This source tree contains both BDR for patched PostgreSQL 9.4 and the
 reduced-functionality UDR variant for unpatched PostgreSQL 9.4. UDR is
 experimental at this time.
 
 See INSTALL.src for details.
+
+The bdr-plugin/next branch is the development tree for the BDR plugin.
+
+Stable branches are named in the form bdr-plugin/RELX_Y_STABLE, e.g.
+bdr-plugin/REL0_9_STABLE.  Tagged releases are named bdr-plugin/X_Y_Z, e.g.
+bdr-plugin/0.9.0 .
+
+BDR requires a patched PostgreSQL 9.4, which is in branches prefixed with
+bdr-pg/ . Tagged BDR plugin releases specify the required bdr-pg version in the
+tag commit message.