some reading

This commit is contained in:
mapsam
2017-07-12 14:32:48 -07:00
parent 3b660439d3
commit 28db5f5ec5
2 changed files with 26 additions and 5 deletions

View File

@@ -1,14 +1,28 @@
# mbtiles
Utilities and [tilelive][1] integration for the [MBTiles][2] format.
Node.js utilities and [tilelive](https://github.com/mapbox/tilelive.js) integration for the [MBTiles](http://mbtiles.org) format.
[![Build Status](https://travis-ci.org/mapbox/node-mbtiles.svg?branch=master)](https://travis-ci.org/mapbox/node-mbtiles)
[![Build status](https://ci.appveyor.com/api/projects/status/04wbok5rs3eroffe)](https://ci.appveyor.com/project/Mapbox/node-mbtiles)
### Installation
# Installation
npm install @mapbox/mbtiles
```
npm install @mapbox/mbtiles
```
```javascript
var MBTiles = require('@mapbox/mbtiles');
```
[1]: https://github.com/mapbox/tilelive.js
[2]: http://mbtiles.org
# API
### MBTiles utilities
**Constructor**
```javascript
new MBTiles('./path/to/file.mbtiles', function(err, mbtiles) {
// mbtiles object
});
```

7
test/index.test.js Normal file
View File

@@ -0,0 +1,7 @@
var MBTiles = require('..');
new MBTiles(__dirname + '/fixtures/plain_1.mbtiles', function(err, mbtiles) {
if (err) throw err;
console.log(MBTiles.list());
});