about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-02-04 14:30:40 -0800
committerEric Wong <normalperson@yhbt.net>2009-02-09 19:50:36 -0800
commit28d571b7cca709641d964e00e6004facb6bfcc7e (patch)
treeed260a408088db92adb190d2b9eddaa6be8ab580 /README
parent66254b6f2b0ebb3899413b12d96614ac9318daae (diff)
downloadunicorn-28d571b7cca709641d964e00e6004facb6bfcc7e.tar.gz
Avoid conflicting with existing Mongrel libraries since
we'll be incompatible and break things w/o disrupting
Mongrel installations.
Diffstat (limited to 'README')
-rw-r--r--README73
1 files changed, 18 insertions, 55 deletions
diff --git a/README b/README
index 816fa32..5021477 100644
--- a/README
+++ b/README
@@ -1,74 +1,37 @@
-= Mongrel:  Simple Fast Mostly Ruby Web Server
+= Unicorn:  UNIX-only fork of Mongrel
 
-Mongrel 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.
+Experimental UNIX-only fork of Mongrel.  No threads.
 
-What makes Mongrel so fast is the careful use of an Ragel extension to provide fast, accurate HTTP 1.1 protocol parsing. This makes the server scream without too many portability issues.
-
-See http://mongrel.rubyforge.org for more information.
+See http://unicorn.bogomips.org for more information.
 
 == License
 
-Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed under the Ruby license and the GPL2. See the include LICENSE file for details.
-
-== Quick Start
-
-The easiest way to get started with Mongrel is to install it via RubyGems and then run a Ruby on Rails application. You can do this easily:
-
- $ gem install mongrel
-
-Now you should have the mongrel_rails command available in your PATH, so just do the following:
-
- $ cd myrailsapp
- $ mongrel_rails start
-
-This will start it in the foreground so you can play with it.  It runs your application in production mode.  To get help do:
-
- $ mongrel_rails start -h
-
-Finally, you can then start in background mode:
+Unicorn is copyright 2009 Eric Wong and contributors.
+It is based on Mongrel:
 
- $ mongrel_rails start -d
+Mongrel is copyright 2007 Zed A. Shaw and contributors. It is licensed
+under the Ruby license and the GPL2. See the include LICENSE file for
+details.
 
-And you can stop it whenever you like with:
-
- $ mongrel_rails stop
+== Quick Start
 
-All of which should be done from your application's directory.  It writes the PID of the process you ran into log/mongrel.pid.
+The easiest way to get started with Unicorn is to install it via
+RubyGems and then run a Ruby on Rails application. You can do this
+easily:
 
-There are also many more new options for configuring the rails runner including changing to a different directory, adding more MIME types, and setting processor threads and timeouts.
+ $ gem install unicorn
 
 == Install
 
-It doesn't explicitly require Camping, but if you want to run the examples/camping/ examples then you'll need to install Camping 1.2 at least (and redcloth I think). These are all available from RubyGems.
-
-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.
+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.
 
 Finally, the source includes a setup.rb for those who hate RubyGems.
 
 == Usage
 
-The examples/simpletest.rb file has the following code as the simplest example:
-
- require 'mongrel'
-
- class SimpleHandler < Mongrel::HttpHandler
-    def process(request, response)
-      response.start(200) do |head,out|
-        head["Content-Type"] = "text/plain"
-        out.write("hello!\n")
-      end
-    end
- end
-
- h = Mongrel::HttpServer.new("0.0.0.0", "3000")
- h.register("/test", SimpleHandler.new)
- h.register("/files", Mongrel::DirHandler.new("."))
- h.run.join
-
-If you run this and access port 3000 with a browser it will say "hello!".  If you access it with any url other than "/test" it will give a simple 404.  Check out the Mongrel::Error404Handler for a basic way to give a more complex 404 message.
-
-This also shows the DirHandler with directory listings.  This is still rough but it should work for basic hosting.  *File extension to mime type mapping is missing though.*
-
 == Contact
 
-E-mail the Mongrel list at http://rubyforge.org/mailman/listinfo/mongrel-users and someone will help you. Comments about the API are welcome.
+Newsgroup and mailing list coming.
+
+Email Eric Wong at normalperson@yhbt.net for now.