Skip to content
This repository has been archived by the owner on Jun 30, 2019. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hannesm committed Mar 19, 2019
1 parent 8192552 commit 8360c3b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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/).
3 changes: 2 additions & 1 deletion resolver/udns_resolver_utils.mli
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 8360c3b

Please sign in to comment.