diff --git a/src/bruit.mli b/src/bruit.mli new file mode 100644 index 0000000..7830867 --- /dev/null +++ b/src/bruit.mli @@ -0,0 +1,11 @@ +(** {! Bruit} is a port of the C library + {{:https://github.com/antirez/linenoise} Linenoise} to OCaml. It is not as + feature complete as the library, contributions are very welcome. + + The main entry point to the library is {! bruit}. *) + +type result = String of string option | Ctrl_c + +val bruit : string -> result +(** [bruit prompt] reads from [stdin] and returns the read string if any, and on + [ctrl+c] returns {! Ctrl_c}. *)