Skip to content

Commit

Permalink
Update README and docs
Browse files Browse the repository at this point in the history
darcs-hash:20080226122832-4fc50-130615bc5ddd525b6bb6b01072515dc34218454d.gz
  • Loading branch information
leahneukirchen committed Feb 26, 2008
1 parent 03b8d6a commit dcb6081
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 13 deletions.
3 changes: 2 additions & 1 deletion AUTHORS
@@ -1,6 +1,7 @@
* Christian Neukirchen <chneukirchen@gmail.com> * Christian Neukirchen <chneukirchen@gmail.com>
* Rails adapter: Christoffer Sawicki <christoffer.sawicki@gmail.com>
* HTTP authentication: Tim Fletcher <twoggle@gmail.com> * HTTP authentication: Tim Fletcher <twoggle@gmail.com>
* Cookie sessions, Static handler: Luc Heinrich <luc@honk-honk.com> * Cookie sessions, Static handler: Luc Heinrich <luc@honk-honk.com>
* Pool sessions, OpenID authentication: blink <blinketje@gmail.com> * Pool sessions, OpenID authentication: blink <blinketje@gmail.com>
* LiteSpeed handler: Adrian Madrid
* SCGI handler: Jeremy Evans
* Official Logo: Armin Ronacher * Official Logo: Armin Ronacher
34 changes: 27 additions & 7 deletions README
Expand Up @@ -13,10 +13,17 @@ which all Rack applications should conform to.


The included *handlers* connect all kinds of web servers to Rack: The included *handlers* connect all kinds of web servers to Rack:
* Mongrel * Mongrel
* Mongrel/Swiftcore (require it before Rack.) * Mongrel/Swiftcore (require it before requiring rack)
* WEBrick * WEBrick
* FCGI * FCGI
* CGI * CGI
* SCGI
* LiteSpeed

These web servers include Rack handlers in their distributions:
* Ebb
* Fuzed
* Thin


Any valid Rack app will run the same on all these handlers, without Any valid Rack app will run the same on all these handlers, without
changing anything. changing anything.
Expand All @@ -25,13 +32,22 @@ changing anything.


The included *adapters* connect Rack with existing Ruby web frameworks: The included *adapters* connect Rack with existing Ruby web frameworks:
* Camping * Camping
* Rails (alpha)
* more to come soon, ...


These frameworks include Rack adapters in their distributions: These frameworks include Rack adapters in their distributions:
* Ramaze * Coset
* Halcyon
* Maveric * Maveric
* Merb
* Racktools::SimpleApplication * Racktools::SimpleApplication
* Ramaze
* Sinatra
* Vintage

Ruby on Rails can be run with the adapter included with Thin, which
will be merged into a later Rack version.

Current links to these projects can be found at
http://ramaze.net/#other-frameworks


== Available middleware == Available middleware


Expand All @@ -42,7 +58,7 @@ applications needs using middleware, for example:
* Rack::ShowException, for catching unhandled exceptions and * Rack::ShowException, for catching unhandled exceptions and
presenting them in a nice and helpful way with clickable backtrace. presenting them in a nice and helpful way with clickable backtrace.
* Rack::File, for serving static files. * Rack::File, for serving static files.
* ... * ...many others!


All these components use the same interface, which is described in All these components use the same interface, which is described in
detail in the Rack specification. You can choose to use them exactly detail in the Rack specification. You can choose to use them exactly
Expand Down Expand Up @@ -110,13 +126,17 @@ at my site:
* Bug fixes in the Camping adapter. * Bug fixes in the Camping adapter.
* Removed Rails adapter, was too alpha. * Removed Rails adapter, was too alpha.


* XXX, 2007: Third public release 0.3. * February 26th, 2008: Third public release 0.3.
* LiteSpeed handler, by Adrian Madrid. * LiteSpeed handler, by Adrian Madrid.
* SCGI handler, by Jeremy Evans. * SCGI handler, by Jeremy Evans.
* Pool sessions, by blink. * Pool sessions, by blink.
* OpenID authentication, by blink. * OpenID authentication, by blink.
* :Port and :File options for opening FastCGI sockets, by blink. * :Port and :File options for opening FastCGI sockets, by blink.
* Last-Modified HTTP header for Rack::File, by blink. * Last-Modified HTTP header for Rack::File, by blink.
* Rack::Builder#use now accepts blocks, by Corey Jewett.
(See example/protectedlobster.ru)
* HTTP status 201 can contain a Content-Type and a body now.
* Many bugfixes, especially related to Cookie handling.


== Contact == Contact


Expand Down Expand Up @@ -149,7 +169,7 @@ You are also welcome to join the #rack channel on irc.freenode.net.


== Copyright == Copyright


Copyright (C) 2007 Christian Neukirchen <http://purl.org/net/chneukirchen> Copyright (C) 2007, 2008 Christian Neukirchen <http://purl.org/net/chneukirchen>


Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to of this software and associated documentation files (the "Software"), to
Expand Down
12 changes: 7 additions & 5 deletions lib/rack.rb
@@ -1,4 +1,4 @@
# Copyright (C) 2007 Christian Neukirchen <purl.org/net/chneukirchen> # Copyright (C) 2007, 2008 Christian Neukirchen <purl.org/net/chneukirchen>
# #
# Rack is freely distributable under the terms of an MIT-style license. # Rack is freely distributable under the terms of an MIT-style license.
# See COPYING or http://www.opensource.org/licenses/mit-license.php. # See COPYING or http://www.opensource.org/licenses/mit-license.php.
Expand All @@ -13,10 +13,10 @@
# so it should be enough just to <tt>require rack.rb</tt> in your code. # so it should be enough just to <tt>require rack.rb</tt> in your code.


module Rack module Rack
# The Rack version number. # The Rack protocol version number implemented.
VERSION = [0,1] VERSION = [0,1]


# Return the Rack version as a dotted string. # Return the Rack protocol version as a dotted string.
def self.version def self.version
VERSION.join(".") VERSION.join(".")
end end
Expand Down Expand Up @@ -62,7 +62,8 @@ module Session


# *Adapters* connect Rack with third party web frameworks. # *Adapters* connect Rack with third party web frameworks.
# #
# Rack includes adapters for Camping and Rails. # Rack includes an adapter for Camping, see README for other
# frameworks supporting Rack in their code bases.
# #
# Refer to the submodules for framework-specific calling details. # Refer to the submodules for framework-specific calling details.


Expand All @@ -72,7 +73,8 @@ module Adapter


# *Handlers* connect web servers with Rack. # *Handlers* connect web servers with Rack.
# #
# Rack includes Handlers for Mongrel, WEBrick, FastCGI and CGI. # Rack includes Handlers for Mongrel, WEBrick, FastCGI, CGI, SCGI
# and LiteSpeed.
# #
# Handlers usually are activated by calling <tt>MyHandler.run(myapp)</tt>. # Handlers usually are activated by calling <tt>MyHandler.run(myapp)</tt>.
# A second optional hash can be passed to include server-specific # A second optional hash can be passed to include server-specific
Expand Down

0 comments on commit dcb6081

Please sign in to comment.