# leaflet

`leaflet` is an [OCaml] bindings library for the [Leaflet] JavaScript library (v1.9.4).

## Installation

`leaflet` can be installed with [opam]:

```sh
opam install leaflet
```

If you don't have `opam`, you can install it following the [how to install opam] guide.

If you can't or don't want to use `opam`, consult the [opam file] for build instructions.

## Usage

The library use `dune-site` to install [leaflet's files] (CSS and images).

Have a look at the [example] folder.
It use [tiny_httpd] to provide a simple web page with a map that use [OpenStreetMap] tiles:
```sh
dune build @install
dune exec example/server.exe
```

## About

This library started off from the code of a [NGI0 funded project]

- [LICENSE]
- [CHANGELOG]

[CHANGELOG]: ./CHANGES.md
[LICENSE]: ./LICENSE.md
[opam file]: ./leaflet.opam
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
[Leaflet]: https://leafletjs.com/
[Leaflet's files]: ./src/vendor/
[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/
[tiny_httpd]: https://github.com/c-cube/tiny_httpd
[example]: ./example/
[OpenStreetMap]: https://www.openstreetmap.org