From b7ade93403021c989bf9258b29a549b0e7f3692e Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Tue, 15 Dec 2009 00:18:59 -0800
Subject: doc: update README, add FAQ

* make it clear we depend on Unicorn and Rainbows!
* point out Sunshowers
* add FAQ
---
 .document |  1 +
 FAQ       | 42 ++++++++++++++++++++++++++++++++++++++++++
 README    | 10 ++++++++--
 3 files changed, 51 insertions(+), 2 deletions(-)
 create mode 100644 FAQ

diff --git a/.document b/.document
index a324f6a..8ed4e69 100644
--- a/.document
+++ b/.document
@@ -3,4 +3,5 @@ lib
 LICENSE
 NEWS
 README
+FAQ
 zbatery.1
diff --git a/FAQ b/FAQ
new file mode 100644
index 0000000..b39d890
--- /dev/null
+++ b/FAQ
@@ -0,0 +1,42 @@
+= Frequently Asked Questions about Zbatery
+
+Be sure to check out the Rainbows!
+{FAQ}[http://rainbows.rubyforge.org/FAQ.html] and the Unicorn
+{FAQ}[http://unicorn.bogomips.org/FAQ.html] as well.
+
+
+=== Mongrel -> Unicorn -> Rainbows! -> Zbatery.  Why another server?
+
+Not everybody can afford to run a master process or multiple worker
+processes.  Nor do they need all the Unix signals support from
+Rainbows!/Unicorn.  We hope this is actually a temporary project that
+can eventually be folded back into Mongrel.
+
+
+=== Why not stick to Mongrel?
+
+Unfortunately Mongrel 2.x development has stalled and the majority of
+the team is busy with other projects.  However, Unicorn and Rainbows!
+development continues with less concern for portability.
+
+Rainbows! is the only Ruby web server we know of that supports a wide
+variety of concurrency models, so we decided to take advantage of
+the options Rainbows! provides instead of being tied to one.
+
+
+=== What's Rack?  Do you support Rails?
+
+{Rack}[http://rack.rubyforge.org/] is a minimal specification between
+Ruby web servers (e.g. Mongrel, Zbatery) and Ruby web frameworks (e.g.
+Rails, Sinatra, Camping).  Instead of requiring a new handler for every
+framework a server wants to support, web servers only need to support
+Rack.  As of late 2009, all major Ruby web frameworks are built on top
+of Rack, including Rails.
+
+
+=== What platforms are supported?
+
+Any platform running matz's Ruby 1.8 or 1.9 should work with Zbatery.
+We have not tested on anything other than GNU/Linux and FreeBSD, so
+please let us know of your success/failure stories.  Rubinius 1.0.0rc1
+appears to work, too (if you're using Unicorn 0.95.2 or later).
diff --git a/README b/README
index af5ffb0..d3f51fa 100644
--- a/README
+++ b/README
@@ -28,7 +28,9 @@ for basic functionality.
   pipe and fork().  Unicorn 0.95.2+ has rake-compiler support, so
   compiling the HTTP parser should be easier at least.
 
-* -Untested- HTML 5 Web Sockets support
+* Web Sockets support (via
+  {Sunshowers}[http://rainbows.rubyforge.org/sunshowers/]), requires
+  Rainbows! 0.9.0+
 
 == License
 
@@ -44,7 +46,7 @@ Zbatery is 100% Free Software.
 == Install
 
 You may download the tarball from the Rainbows project page on Rubyforge
-and run setup.rb after unpacking it:
+and run setup.rb after unpacking it (and installing Unicorn and Rainbows!):
 
 http://rubyforge.org/frs/?group_id=8977
 
@@ -52,6 +54,10 @@ You may also install it via RubyGems on Gemcutter:
 
   gem install zbatery
 
+Zbatery depends on Rainbows!, and in turn, Unicorn.  Despite Unicorn and
+Rainbows! being Unix-only, the Unicorn HTTP parser C extension should
+build on non-Unix-like systems (unverified).
+
 == Usage
 
 === for Rack applications
-- 
cgit v1.2.3-24-ge0c7