From 5e2968a87ea33063f950ecae7ddfd250681b3795 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sat, 14 Sep 2019 10:42:03 -0500 Subject: [PATCH] doc: update readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7862db2..71fe714 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ A simple wrapper around OCurl, for easy tasks around http. +**project goals** + +- be as simple to use as possible. +- be as reliable as possible (work is done by cURL and the ocurl bindings anyway). +- stable API with few dependencies, so that user code compiles without breakage + for a long time. + ## Installation - for the synchronous library: `opam install ezcurl` @@ -36,6 +43,8 @@ val content : Ezcurl_core.response = - : int = 200 ``` +It is also possible to create a client with `Ezcurl.make()` and re-use +it across calls with the optional parameter `client`. ### Lwt API