From bc8581bcadec8fa05d4bad6c291e9a9ac09da420 Mon Sep 17 00:00:00 2001 From: Young Hahn Date: Thu, 19 May 2011 13:00:11 -0400 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c8e4eeb..62f576a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -Use with `pluggable` branch of `tilelive.js`. +# mbtiles + +MBTiles manipulation utilities and API integration for [tilelive.js][1]. + + +### Installation + + npm install mbtiles + + +### tilelive.js integration + +Example of using `tilelive` to serve tiles from an `mbtiles` file. + + var tilelive = new Server(require('mbtiles')), + tilelive.serve({ + datasource: '/my/map.mbtiles', + x: 0, + y: 0, + z: 0, + format: 'png' + }, function(err, data) { + if (!err) throw Err + // data[0]: PNG image + // data[1]: HTTP headers object appropriate for PNG format + }); + + +[1]: https://github.com/mapbox/tilelive.js -@TODO