File: README.md

package info (click to toggle)
wax.js 5.0.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 556 kB
  • ctags: 540
  • sloc: makefile: 97
file content (45 lines) | stat: -rw-r--r-- 1,317 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Wax

Tools for improving web maps. The centerpiece of the code is a client implementation of the [MBTiles interaction specification](https://github.com/mapbox/mbtiles-spec).

For full documentation of supported mapping APIs and how to use Wax see http://mapbox.github.com/wax.

## Versions

There are three current development branches of Wax:

* `master`, this branch, supports **Modest Maps 1.0.0-alpha2 and later**
* 4.x supports **Modest Maps 0.x**, older versions of Modest Maps
* 6.x is **unstable** and will introduce new **event-based interaction APIs**

To find more detail of what has changed in each version, consult `CHANGELOG.md`.

## Compatibility

* Google Maps API v3
* Leaflet 0.x.x
* Modest Maps 1.x.x
* OpenLayers 2.11

## Building Wax

For end users, a minified library is already provided in `dist/`.

But for developers you can rebuild a minified library by running:

    npm install --dev
    make

## Includes

Wax currently includes three externals:

* [reqwest](https://github.com/ded/reqwest) (MIT)
* [mustache.js](https://github.com/janl/mustache.js) (MIT)
* [html-sanitizer from Google Caja](http://code.google.com/p/google-caja/source/browse/trunk/src/com/google/caja/plugin/html-sanitizer.js) (Apache)

## Authors

- Tom MacWright (tmcw)
- Young Hahn (yhahn)
- Will White (willwhite)