some reading
This commit is contained in:
24
README.md
24
README.md
@@ -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.
|
||||
|
||||
[](https://travis-ci.org/mapbox/node-mbtiles)
|
||||
[](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
7
test/index.test.js
Normal 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());
|
||||
|
||||
});
|
||||
Reference in New Issue
Block a user