diff options
Diffstat (limited to 'doc/rdoc/files/README.html')
| -rw-r--r-- | doc/rdoc/files/README.html | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/doc/rdoc/files/README.html b/doc/rdoc/files/README.html new file mode 100644 index 0000000..9a4fb64 --- /dev/null +++ b/doc/rdoc/files/README.html @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>File: README</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> + <meta http-equiv="Content-Script-Type" content="text/javascript" /> + <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> + <script type="text/javascript"> + // <![CDATA[ + + function popupCode( url ) { + window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") + } + + function toggleCode( id ) { + if ( document.getElementById ) + elem = document.getElementById( id ); + else if ( document.all ) + elem = eval( "document.all." + id ); + else + return false; + + elemStyle = elem.style; + + if ( elemStyle.display != "block" ) { + elemStyle.display = "block" + } else { + elemStyle.display = "none" + } + + return true; + } + + // Make codeblocks hidden by default + document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) + + // ]]> + </script> + +</head> +<body> + + + + <div id="fileHeader"> + <h1>README</h1> + <table class="header-table"> + <tr class="top-aligned-row"> + <td><strong>Path:</strong></td> + <td>README + </td> + </tr> + <tr class="top-aligned-row"> + <td><strong>Last Update:</strong></td> + <td>Thu Jan 26 01:27:16 EST 2006</td> + </tr> + </table> + </div> + <!-- banner header --> + + <div id="bodyContent"> + + + + <div id="contextContent"> + + <div id="description"> + <h2><a href="../classes/Mongrel.html">Mongrel</a>: Simple Fast Mostly Ruby Web Server</h2> +<p> +<a href="../classes/Mongrel.html">Mongrel</a> is a small library that +provides a very fast HTTP 1.1 server for Ruby web applications. It is not +particular to any framework, and is intended to be just enough to get a web +application running behind a more complete and robust web server. +</p> +<p> +What makes <a href="../classes/Mongrel.html">Mongrel</a> so fast is the +careful use of a C extension to provide fast HTTP 1.1 protocol parsing and +fast URI lookup. This combination makes the server very fast without too +many portability issues. +</p> +<h2>Status</h2> +<p> +<a href="../classes/Mongrel.html">Mongrel</a> is still very ALPHA work, but +you can see how it’s used with the Camping framework (version 1.2) +and take a look at how you might use it. Right now it handles HTTP requests +well and process the responses fast, but you have to "roll your +own" response code. +</p> +<p> +The next release of <a href="../classes/Mongrel.html">Mongrel</a> will have +improved IO handling, much more stability, and should have a better <a +href="../classes/Mongrel/HttpResponse.html">Mongrel::HttpResponse</a> +object with more useful features. +</p> +<h2>Install</h2> +<p> +You can install it via source from <a +href="http://www.zedshaw.com/downloads/mongrel">www.zedshaw.com/downloads/mongrel</a>/ +or you can gram a RubyGem at <a +href="http://www.zedshaw.com/downloads/mongrel">www.zedshaw.com/downloads/mongrel</a>/ +and install that manually. I’m working on setting up a RubyForge +project. +</p> +<p> +It doesn’t explicitly require Camping, but if you want to run the +examples/tepee.rb example then you’ll need to install Camping 1.2 at +least (and redcloth I think). These are all available from RubyGems. +</p> +<p> +The library consists of a C extension so you’ll need a C compiler or +at least a friend who can build it for you. +</p> +<p> +Finally, the source include a setup.rb for those who hate RubyGems. +</p> +<h2>Usage</h2> +<p> +Best place to look for usage examples right now is the examples/ directory. +</p> +<h2>Speed</h2> +<p> +This 0.1.2 release will not be as fast as the 0.1.1 release since +I’ve temporarily removed threads as a test. There were many stability +issues related to handling each request in a thread, especially on OSX. +I’ve taken them out for now to make things stable. Even with this +removed <a href="../classes/Mongrel.html">Mongrel</a> is still pretty fast +compared to WEBrick. +</p> +<h2>Contact</h2> +<p> +E-mail zedshaw at zedshaw.com and I’ll help. Comments about the API +are welcome. +</p> + + </div> + + + </div> + + + </div> + + + <!-- if includes --> + + <div id="section"> + + + + + + + + + <!-- if method_list --> + + + </div> + + +<div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> +</div> + +</body> +</html>
\ No newline at end of file |