diff --git a/README.md b/README.md index 773b4a1..daa9ab0 100644 --- a/README.md +++ b/README.md @@ -71,9 +71,9 @@ The µDNS library is published under the 2 clause BSD license. ## Installation You first need to install [OCaml](https://ocaml.org) (at least 4.04.0) and -[opam](https://opam.ocaml.org), the OCaml package manager (at least 1.2.2) on +[opam](https://opam.ocaml.org), the OCaml package manager (at least 2.0.0) on your machine (you can use opam to install an up-to-date OCaml (`opam switch -4.06.0`)). You may want to follow the [mirage installation +4.07.1`)). You may want to follow the [mirage installation instructions](https://mirage.io/wiki/install) to get `mirage` installed on your computer. @@ -85,4 +85,4 @@ examples at the [unikernel repository](https://github.com/roburio/unikernels). ## Documentation -Is unfortunately only in the code at the moment. +API documentation [is available online](https://roburio.github.io/udns/doc/). diff --git a/resolver/udns_resolver_utils.mli b/resolver/udns_resolver_utils.mli index 2d94e9a..bc39f03 100644 --- a/resolver/udns_resolver_utils.mli +++ b/resolver/udns_resolver_utils.mli @@ -1,6 +1,7 @@ (* (c) 2017, 2018 Hannes Mehnert, all rights reserved *) -val scrub : ?mode:[ `Recursive | `Stub ] -> Domain_name.t -> Udns_packet.question -> Udns_packet.header -> Udns_packet.query -> +val scrub : ?mode:[ `Recursive | `Stub ] -> Domain_name.t -> + Udns_packet.question -> Udns_packet.header -> Udns_packet.query -> ((Udns_enum.rr_typ * Domain_name.t * Udns_resolver_entry.rank * Udns_resolver_entry.res) list, Udns_enum.rcode) result