From: Ahmed <ahmed.bessifi@gmail.com>
Date: Sat, 18 Jan 2014 22:05:12 +0000 (-0600)
Subject: Add requirements section to README.md
X-Git-Url: http://git.rot13.org/?p=pgpool-online-recovery;a=commitdiff_plain;h=bd99e627277962e72502e2a09f89015f8833df12

Add requirements section to README.md
---

diff --git a/README.md b/README.md
index 9b0aed1..8a29df3 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,21 @@ pgpool-online-recovery
 ======================
 
 This simple project aims to automate and make easy the online recovery process of a failed pgpool's backend node in master/slave mode.
+
+Requirements
+============
+
+There are two requirements to these scripts to work.
+
+*The first one is [pgpool2](http://www.pgpool.net) (v3.1.3) available in [Debian Wheezy](http://packages.debian.org/stable/database/pgpool2). We assume that pgpool2 is installed and set up in master/slave mode.
+*The second one is obviously Postgres server (v9.1) also available in Wheezy packages repository.
+
+There are several tutorials about setting up pgpool2 and postgres servers with [Streaming Replication](http://wiki.postgresql.org/wiki/Streaming_Replication) and this readme is far to be a howto for configuring both of them. You can check out [this tutorial](https://aricgardner.com/databases/postgresql/pgpool-ii-3-0-5-with-streaming-replication/) which describes really all the steps needed.
+
+Installation and configuration
+==============================
+
+
+
+Tests
+=====