From 3deea9e58502d260ef88b5327f2ed701b705e5ea Mon Sep 17 00:00:00 2001
From: Simon Cruanes <simon.cruanes.2007@m4x.org>
Date: Sat, 15 Feb 2025 16:56:38 -0500
Subject: [PATCH] add readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1266d69
--- /dev/null
+++ b/README.md
@@ -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