44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
|
|
|
|
[Mappa](https://mappa.js.org/)
|
|
========
|
|
|
|
[](https://travis-ci.org/cvalenzuela/Mappa)
|
|
[](https://codecov.io/github/cvalenzuela/Mappa)
|
|
|
|
|
|
Mappa.js is a Javascript library that allows you to overlay a `<canvas>` on top of a tile map. It also provides a set of tools for working with static maps, interactive tile maps and geo-data among other tools useful when building geolocation-based visual representations.
|
|
|
|
Mappa was originally designed for [p5.js](https://github.com/processing/p5.js), but it can be used with plain Javascript or with other libraries that use the canvas element as the render object.
|
|
|
|
## Reference
|
|
|
|
- [Getting Started](https://mappa.js.org/docs/getting-started.html)
|
|
- [API Reference](https://mappa.js.org/docs/api-mappa.html)
|
|
- [Examples](https://mappa.js.org/docs/examples-google-maps.html)
|
|
- [Tutorials](https://mappa.js.org/docs/introduction-to-web-maps.html)
|
|
|
|
## Usage
|
|
|
|
Download the [full](dist/mappa.js), [minified](dist/mappa.min.js) or use the online version and add it to the head section of the document. Mappa will automatically load the required map libraries when necessary.
|
|
|
|
```html
|
|
<script src="mappa.min.js" type="text/javascript"></script>
|
|
```
|
|
or
|
|
```html
|
|
<script src="https://unpkg.com/mappa-mundi/dist/mappa.min.js" type="text/javascript"></script>
|
|
```
|
|
|
|
If you are using npm:
|
|
```bash
|
|
npm install mappa-mundi
|
|
```
|
|
|
|
## Licence
|
|
MIT
|
|
|
|
## GSOC
|
|
|
|
|
|
Project developed as part of Google Summer of Code 2017
|