add readme

This commit is contained in:
Simon Cruanes 2025-02-15 16:56:38 -05:00
parent 6007cf9392
commit 3deea9e585
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4

31
README.md Normal file
View file

@ -0,0 +1,31 @@
# nanoev
A minimalistic but modular abstraction for IO event loops.
The goal of this library is to provide a uniform abstraction over multiple
system event loops, in a way that plays well with Picos.
## Usage
Very basic usage would look like this:
```ocaml
module EV = Nanoev_picos
let () =
(* use a backend, eg. select *)
let ev = Nanoev_unix.create () in
(* install the backend *)
Nanoev_picos.setup_bg_thread ev;
(* setup a picos scheduler and use EV.read, EV.write, etc. *)
```
## Backends
- [x] select
- [ ] uring