From 767ec49d35e23eafe6464668c63ade53a9ac3d99 Mon Sep 17 00:00:00 2001 From: Simon Tokumine Date: Fri, 7 Oct 2011 18:31:45 +0100 Subject: [PATCH] update readme --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a2a3af2b..a121039c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ Windshaft-CartoDB ================== -This is the CartoDB map tiler. +This is the CartoDB map tiler. It extends Windshaft with some extra functionality and custom filters for authentication -Look at lib/cartodb/server_options to see how we configure windshaft +Look at lib/cartodb/server_options for more on config + +* reads dbname from subdomain and cartodb redis for pretty tile urls +* configures windshaft to publish cartodb_id as the interactivity layer +* gets the default geometry type from the cartodb redis store +* provides a infowindow endpoint for windshaft +* provides a map_metadata endpoint for windshaft Install @@ -15,14 +21,6 @@ node app.js [development | production] ``` -Core features -------------- -* reads dbname from subdomain and cartodb redis for pretty tile urls -* configures windshaft to publish cartodb_id as the interactivity layer -* gets the default geometry type from the cartodb redis store -* provides an ultra basic infowindow endpoint for windshaft -* provides an ultra basic map_metadata endpoint for windshaft - URLs ---- @@ -56,4 +54,13 @@ Args: * infowindow - returns contents of infowindow from CartoDB. +**MAP METADATA** + +[GET] subdomain.cartodb.com/tiles/:table_name/map_metadata + +Args: + +* infowindow - returns contents of infowindow from CartoDB. + + All GET requests are wrappable with JSONP using callback argument, including the UTFGrid map tile call. \ No newline at end of file