Commit b385eb2c authored by Iván Sánchez Ortega's avatar Iván Sánchez Ortega
Browse files

Tweak readme: <script> usage, gotchas, links to glii&arrugator

parent 48c1e6eb
Pipeline #267823269 passed with stages
in 1 minute and 37 seconds
......@@ -2,7 +2,7 @@
Displays reprojected raster images.
Leverages Glii for not going insane with the WebGL bits, and Arrugator for calculating the triangle mesh for raster reprojection.
Leverages [Glii](https://gitlab.com/IvanSanchez/glii) for not going insane with the WebGL bits, and [Arrugator](https://gitlab.com/IvanSanchez/arrugator) for calculating the triangle mesh for raster reprojection.
### Demo
......@@ -12,7 +12,13 @@ The demo linked above uses a downsampled version of the [N5000 raster dataset fr
### Usage
This adds a `L.imageOverlay.arrugator` factory to the Leaflet namespace.
This Leaflet plugin adds a `L.ImageOverlay.Arrugator` class and a `L.imageOverlay.arrugator` factory to the Leaflet namespace.
Load the plugin in a `<script>` tag, from a local copy or from a CDN, e.g.
```html
<script src='https://unpkg.com/leaflet.imageoverlay.arrugator@1.0.0/dist/leaflet.imageoverlay.arrugator.js'></script>
```
Usage is as follows:
......@@ -54,6 +60,14 @@ L.imageOverlay.arrugator(
).addTo(map);
```
### Gotchas
Even though the name of the plugin is `L.ImageOverlay.Arrugator`, this class does **not** inherit from `L.ImageOverlay` but, rather, implements parts of `L.Canvas` to support a glii-powered WebGL rendering.
This shouldn't be a problem, but is worth mentioning.
The epsilon for the arrugator triangulation process cannot be changed after instantiation (yet).
### Legalese
Released under the General Public License, v3. See the LICENSE file for details.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment