From 0ffd33820c6eeeb77d0fb8d4ec936307cefe93a1 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Thu, 22 Jun 2017 13:37:05 +0900
Subject: [PATCH] Update README

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 164dcf4a..d8dad426 100644
--- a/README.md
+++ b/README.md
@@ -12,4 +12,37 @@ operations.
 Commands
 --------
 
-repmgr cluster event [--all] [--node-id] [--node-name] [--event] [--event-matching]
\ No newline at end of file
+Currently available:
+
+    repmgr master register
+    repmgr master unregister
+
+    repmgr standby clone
+    repmgr standby register
+    repmgr standby unregister
+    repmgr standby promote
+    repmgr standby follow
+
+    repmgr cluster event [--all] [--node-id] [--node-name] [--event] [--event-matching]
+
+
+Backwards compatibility
+-----------------------
+
+`repmgr` is now implemented as a PostgreSQL extension.
+
+Metadata tables have been revised and are not backwards-compatible
+with 3.x. (however future DDL updates will be easier as they can be
+carried out via the ALTER EXTENSION mechanism.
+
+TODO: extension upgrade script for pre-4.0
+
+Some configuration items have had their names changed for consistency
+and clarity e.g. `node` => `node_id`. `repmgr` will issue a warning
+about deprecated/altered options.
+
+Some configuration items have been changed to command line options,
+and vice-versa, e.g. to avoid hard-coding things like a node's
+upstream ID which might change.
+
+TODO: possibly add a config file conversion script/function.