about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 18 insertions, 4 deletions
diff --git a/README b/README
index 202c9ef..1d5a307 100644
--- a/README
+++ b/README
@@ -1,11 +1,25 @@
-= kcar - retrevnoc esnopser kcaR ot maertsetyb
+= kcar - bytestream to Rack response converter
+
+kcar features an HTTP parser that will convert a bytestream into a
+3-element array suitable for use as a Rack response.  It is IO interface
+agnostic, so it may be used with HTTP streams over Unix domain sockets,
+regular files, FIFOs, StringIOs as well as traditional TCP sockets.
+
+A drop-in, Net::HTTP-compatible interface is planned.
 
 == Features
 
-* RFC2616-compliant Ragel/C HTTP parser adapted from Unicorn and Mongrel
+* RFC2616-compliant Ragel+C parser adapted from Unicorn and Mongrel
 
-* decodes chunked bodies
+* decodes chunked response bodies with an optional pass-through mode
+  (to avoid rechunking with Rack::Chunked)
 
 * handles odd things like trailers and multiline headers
 
-* streaming interface for response bodies for incremental processing
+* streaming interface for response bodies allows for incremental
+  processing of arbitrarily large responses.
+
+== Problems
+
+* kcar is only lightly tested and is not yet aware of all quirks found in
+  all real (possibly broken) web servers.