commit 98667bd678cf9ff5d7e27faf8a668bc8b331295f
from: Omar Polo <op@omarpolo.com>
date: Tue Dec 19 22:59:21 2023 UTC

ev: add a simple README

commit - d2f8aa1ddcef54f8da65783f935f4b0b363affc5
commit + 98667bd678cf9ff5d7e27faf8a668bc8b331295f
blob - /dev/null
blob + 1782181839b49eaf0b0466d5ccc8d956f7d5fa6b (mode 644)
--- /dev/null
+++ ev/README
@@ -0,0 +1,12 @@
+The ev module implements an event loop for files and signals.  There's
+an implicit global event loop accessible via the [[add]], [[del]],
+[[loop]] and [[loopbreak]] functions as well as the support for
+manually creating event loop via [[new]] and the methods returned.
+
+Signals can be safely catched and the registered callback is called in
+the main code environment, and not in a signal context, so no special
+attention is needed.  At the moment, signals can only be handled as
+part of the implicit global event loop.
+
+Caveats: if the event A deletes the event B, and the event B is
+already pending, it can still be fired once.