From f37fba639279f2dbee8ab90f3dc0dafd032ec66f Mon Sep 17 00:00:00 2001
From: Mario de Frutos <ethervoid@gmail.com>
Date: Mon, 23 Nov 2015 10:12:06 +0100
Subject: [PATCH] Added readme for the client extension

---
 client/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 45 insertions(+), 2 deletions(-)

diff --git a/client/README.md b/client/README.md
index c4e8032..e20e0da 100644
--- a/client/README.md
+++ b/client/README.md
@@ -1,2 +1,45 @@
-# Geocoder API Client
-The CartoDB Geocoder SQL API client
+# CartoDB geocoder API client extension
+Postgres extension for the CartoDB geocoder API, client side.
+
+## Dependencies
+This extension is thought to be used on top of CartoDB geocoder extension, for the multiples available geocoders (internal, nokia, etc). 
+
+The following is a non-comprehensive list of dependencies:
+
+- Postgres 9.3+
+- Postgis extension
+- Schema triggers extension
+- CartoDB extension
+
+## Installation into the db cluster
+This requires root privileges
+```
+sudo make all install
+```
+
+## Execute tests
+```
+PGUSER=postgres make installcheck
+```
+
+## Build, install & test
+One-liner:
+```
+sudo PGUSER=postgres make all install installcheck
+```
+
+## Install onto a cartodb user's database
+
+Remember that **is mandatory to install it on top of cdb_geocoder**
+
+```
+psql -U postgres cartodb_dev_user_fe3b850a-01c0-48f9-8a26-a82f09e9b53f_db
+```
+
+and then:
+
+```sql
+CREATE EXTENSION cdb_geocoder_client;
+```
+
+The extension creation in the user's db requires **superuser** privileges.