package bitcoin-cohttp-async

README

=========================================================================
| README for OCaml-bitcoin                                              |
|                                                                       |
| http://ocaml-bitcoin.forge.ocamlcore.org/                             |
|                                                                       |
| Dario Teixeira <dario.teixeira@nleyten.com>                           |
=========================================================================


1. Overview
===========

OCaml-bitcoin is a library offering an OCaml interface to the official
Bitcoin client API [1].  It works by making JSON-RPC calls over the
network to a running Bitcoin daemon offering the client API.


2. Dependencies
===============

The core library depends solely on Yojson and Cryptokit [2,3].
The optional auxiliary engines each have their own set of dependencies:

  * Bitcoin_ocamlnet: Ocamlnet's Netclient [4].
  * Bitcoin_ocsigen: Lwt and the Ocsigen server libraries [5,6].
  * Bitcoin_cohttp_lwt: Lwt and Cohttp [5,7].
  * Bitcoin_cohttp_async: Async and Cohttp.
  * Bitcoin_ocurl: OCurl [8].


3. Building and installing
==========================

This project is managed by dune and should be installable via opam.

Example opam installation command.

```
opam install bitcoin-cohttp-async
```

To use in your project simply list `bitcoin-cohttp-async` in your dune
libraries stanza.

4. License
==========

OCaml-bitcoin is distributed under the terms of the GNU LGPL version 2.1
(with OCaml linking exception).  See LICENSE file for full license text.


5. Contributors
===============

Vincent Bernardoff contributed the engines based on OCurl and Cohttp.


References
==========

[1] http://bitcoin.org/en/developer-reference
[2] http://mjambon.com/yojson.html
[3] http://forge.ocamlcore.org/projects/cryptokit/
[4] http://projects.camlcity.org/projects/ocamlnet.html
[5] http://ocsigen.org/lwt/
[6] http://ocsigen.org/ocsigenserver/
[7] http://github.com/mirage/ocaml-cohttp
[8] http://ocurl.forge.ocamlcore.org/
[9] http://oasis.forge.ocamlcore.org/