Update README.md

This commit is contained in:
Young Hahn
2011-05-19 13:00:11 -04:00
parent 41861caf26
commit bc8581bcad

View File

@@ -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