misc documentation updates

We shall release without SignalFD support

5 files changed, 22 insertions, 9 deletions

diff --git a/.document b/.document
index b47f875..52f77e5 100644
--- a/.document
+++ b/.document
@@ -4,4 +4,7 @@ TODO
 NEWS
 ChangeLog
 lib
-ext/sleepy_penguin/epoll.c
+ext/sleepy_penguin/init.c
+ext/sleepy_penguin/eventfd.c
+ext/sleepy_penguin/timerfd.c
+TODO
diff --git a/LICENSE b/LICENSE
index 6e1e183..814ed0d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,5 +1,5 @@
-ruby_epoll is copyrighted Free Software by all contributors, see logs in
-revision control for names and email addresses of all of them.
+sleepy_penguin is copyrighted Free Software by all contributors, see
+logs in revision control for names and email addresses of all of them.
 
 You can redistribute it and/or modify it under the terms of the GNU
 Lesser General Public License (LGPL) as published by the Free Software
@@ -8,10 +8,10 @@ or {3}[http://www.gnu.org/licenses/lgpl-3.0.txt] (see link:COPYING).
 The project leader (Eric Wong) reserves the right to relicense raindrops
 under future versions of the LGPL.
 
-ruby_epoll is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
-License for more details.
+sleepy_penguin is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
+General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software
diff --git a/README b/README
index 1856b61..47500b3 100644
--- a/README
+++ b/README
@@ -2,7 +2,7 @@
 
 sleepy_penguin provides access to newer, Linux-only system calls to wait
 on events from traditionally non-I/O sources.  Bindings to the eventfd,
-signalfd, timerfd, and epoll interfaces are provided.
+timerfd, and epoll interfaces are provided.
 
 == Features
 
@@ -10,6 +10,11 @@ signalfd, timerfd, and epoll interfaces are provided.
 
 * IO-like objects are backwards-compatible with IO.select.
 
+* Epoll interface is fork-safe
+
+* Unlike portable event frameworks, the Linux-only Epoll interface
+  allows using edge-triggered I/O for possibly improved performance
+
 == Install
 
 If you're using a packaged Ruby distribution, make sure you have a C
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..4a9f2f7
--- /dev/null
+++ b/TODO
@@ -0,0 +1,3 @@
+* SignalFD interface
+
+* Inotify? Several libraries already support it, but it fits this project, too
diff --git a/lib/sleepy_penguin.rb b/lib/sleepy_penguin.rb
index c8cd8d3..1a5c441 100644
--- a/lib/sleepy_penguin.rb
+++ b/lib/sleepy_penguin.rb
@@ -1,5 +1,7 @@
 # -*- encoding: binary -*-
 module SleepyPenguin
-  VERSION = '1.0.0'
+
+  # the version of sleepy penguin, currently 1.0.0
+  SLEEPY_PENGUIN_VERSION = '1.0.0'
 end
 require 'sleepy_penguin_ext'