simon/ezcurl
1
0
Fork 0
mirror of https://github.com/c-cube/ezcurl.git synced 2025-12-11 13:38:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update readme

Browse source
This commit is contained in:
Simon Cruanes 2019-09-14 10:42:03 -05:00
parent 1dcde0d0a8
commit 5e2968a87e
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,6 +2,13 @@
A simple wrapper around OCurl, for easy tasks around http. 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 ## Installation
- for the synchronous library: `opam install ezcurl` - for the synchronous library: `opam install ezcurl`
@ -36,6 +43,8 @@ val content : Ezcurl_core.response =
- : int = 200 - : 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 ### Lwt API