librelist archives

« back to archive

[PATCH] README: update with latest features

[PATCH] README: update with latest features

From:
Eric Wong
Date:
2013-05-02 @ 23:00
We support kqueue and Rubinius.  Nowadays, we also export
the potentially dangerous low-level APIs for epoll and kqueue.
---
 README | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/README b/README
index 551ce8e..9574dce 100644
--- a/README
+++ b/README
@@ -2,19 +2,21 @@
 
 sleepy_penguin provides access to newer, Linux-only system calls to wait
 on events from traditionally non-I/O sources.  Bindings to the eventfd,
-timerfd, inotify, and epoll interfaces are provided.
+timerfd, inotify, and epoll interfaces are provided.  Experimental support
+for kqueue on FreeBSD (and likely OpenBSD/NetBSD) are also provided.
 
 == Features
 
-* Thread-safe blocking operations for all versions of Ruby
+* Thread-safe blocking operations for all versions of Matz Ruby and Rubinius
 
 * IO-like objects are backwards-compatible with IO.select.
 
-* Epoll interface is fork-safe and GC-safe
+* High-level Epoll interface is fork-safe and GC-safe
 
 * Unlike portable event frameworks, the Linux-only epoll interfaces
   allow using edge-triggered or one-shot notifications for possibly
-  improved performance
+  improved performance.  Likewise, the kqueue interface supports
+  one-shot notifiactions, too.
 
 * Fully-documented and user-friendly API
 
-- 
1.8.2.rc3.2.geae6cf5