Add documentation

Nathan · Nathan · commit 05ddeab9500b · 2017-02-06T13:46:30.000+01:00
diff --git a/doc/api.odocl b/doc/api.odocl
@@ -0,0 +1 @@
+Zxcvbn
diff --git a/opam b/opam
@@ -5,6 +5,7 @@ homepage: "https://github.com/cryptosense/ocaml-zxcvbn"
 bug-reports: "https://github.com/cryptosense/ocaml-zxcvbn/issues"
 license: "BSD-2"
 dev-repo:  "https://github.com/cryptosense/ocaml-zxcvbn.git"
+doc: "https://cryptosense.github.io/ocaml-zxcvbn/doc"
 build: [
   [ "ocaml" "pkg/pkg.ml" "build" "--pinned" "%{pinned}%" ]
 ]
diff --git a/src/zxcvbn.mli b/src/zxcvbn.mli
@@ -1,3 +1,5 @@
+(** Bindings to the zxcvbn password strength estimation library *)
+
 module Match : sig
   type typ =
     | Non_match
@@ -25,4 +27,5 @@ module Match : sig
   [@@deriving eq, ord, show]
 end
 
+(** Return the overall password entropy estimation and the list of match *)
 val matches : string -> float * Match.t list

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ homepage: "https://github.com/cryptosense/ocaml-zxcvbn"`
`5`	`5`	`bug-reports: "https://github.com/cryptosense/ocaml-zxcvbn/issues"`
`6`	`6`	`license: "BSD-2"`
`7`	`7`	`dev-repo: "https://github.com/cryptosense/ocaml-zxcvbn.git"`
	`8`	`+doc: "https://cryptosense.github.io/ocaml-zxcvbn/doc"`
`8`	`9`	`build: [`
`9`	`10`	`[ "ocaml" "pkg/pkg.ml" "build" "--pinned" "%{pinned}%" ]`
`10`	`11`	`]`