cartodb4/Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Simon Tokumine 2011-10-07 18:31:45 +01:00
parent 60e5dbe0b0
commit 767ec49d35
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,9 +1,15 @@
Windshaft-CartoDB 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 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 URLs
---- ----
@ -56,4 +54,13 @@ Args:
* infowindow - returns contents of infowindow from CartoDB. * 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. All GET requests are wrappable with JSONP using callback argument, including the UTFGrid map tile call.