From 28db5f5ec5c827a5a67e4b1e546506758686010c Mon Sep 17 00:00:00 2001 From: mapsam Date: Wed, 12 Jul 2017 14:32:48 -0700 Subject: [PATCH] some reading --- README.md | 24 +++++++++++++++++++----- test/index.test.js | 7 +++++++ 2 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 test/index.test.js diff --git a/README.md b/README.md index 1d035d8..4a5e790 100644 --- a/README.md +++ b/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. [![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 +}); +``` diff --git a/test/index.test.js b/test/index.test.js new file mode 100644 index 0000000..0ef764e --- /dev/null +++ b/test/index.test.js @@ -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()); + +});