diff --git a/README.md b/README.md index 05578085..1f0be704 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PostgreSQL HA with etcd +# Template for PostgreSQL HA with etcd To get started, do the following from different terminals: @@ -12,5 +12,20 @@ From there, you will see a high-availability cluster start up. Test different settings in the YAML files to see how behavior changes. Kill some of the different components to see how the system behaves. -Cheers, -Chris +# Requirements on a Mac + +Run the following on a Mac to install requirements: + +``` +brew install postgresql etcd haproxy libyaml +pip install psycopg2 pyyaml +``` + +# Notice + +There are many different ways to do HA with PostgreSQL, see (the +docs)[https://wiki.postgresql.org/wiki/Replication,_Clustering,_and_Connection_Pooling] for a complete list. + +We call this project a "template" because it is far from a one-size fits +all, or a plug-and-play replication system. It will have it's own +caveats. Use wisely.