Browse Source

add usage to readme

pull/9/head
Swrup 2 years ago
parent
commit
0a5f5519da
  1. 2
      .ocamlformat
  2. 4
      CHANGES.md
  3. 11
      README.md
  4. 1
      dune-project
  5. 1
      leaflet.opam

2
.ocamlformat

@ -1,4 +1,4 @@
version=0.21.0
version=0.22.4
assignment-operator=end-line
break-cases=fit
break-fun-decl=wrap

4
CHANGES.md

@ -1 +1,3 @@
## unreleased
## 0.1
Initial release.

11
README.md

@ -14,13 +14,12 @@ If you don't have `opam`, you can install it following the [how to install opam]
If you can't or don't want to use `opam`, consult the [opam file] for build instructions.
## Quickstart
## Usage
```ocaml
let () = Format.printf "TODO@."
```
Have a look at the [example] folder.
The documentation can be consulted via `odig doc leaflet`.
For more, have a look at the [example] folder, at the [documentation] or at the [test suite].
You will also need [leaflet's files] (CSS and images).
## About
@ -35,9 +34,9 @@ leaflet's original code was taken from a [NGI0 funded project]
[opam file]: ./leaflet.opam
[test suite]: ./test
[documentation]: TODO/leaflet
[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]: https://leafletjs.com/download.html
[NGI0 funded project]: https://nlnet.nl/project/openEngiadina/

1
dune-project

@ -29,5 +29,6 @@
(tags
(leaflet javascript bindings interactive map openstreetmap))
(depends
brr
(ocaml
(>= 4.08))))

1
leaflet.opam

@ -16,6 +16,7 @@ doc: "TODO/leaflet"
bug-reports: "https://git.zapashcanon.fr/swrup/leaflet/issues"
depends: [
"dune" {>= "2.9"}
"brr"
"ocaml" {>= "4.08"}
"odoc" {with-doc}
]

Loading…
Cancel
Save