Sort list of allowed methods. RT#81825

[catagits/Catalyst-Action-REST.git] / README

diff --git a/README b/README
index ad03601..7d38474 100644 (file)
--- a/README
+++ b/README
@@ -36,14 +36,15 @@ DESCRIPTION
 
     If you do not provide an _OPTIONS subroutine, we will automatically
     respond with a 200 OK. The "Allow" header will be populated with the
-    list of implemented request methods.
+    list of implemented request methods. If you do not provide an _HEAD
+    either, we will auto dispatch to the _GET one in case it exists.
 
     It is likely that you really want to look at Catalyst::Controller::REST,
     which brings this class together with automatic Serialization of
     requests and responses.
 
-    When you use this module, the request class will be changed to
-    Catalyst::Request::REST.
+    When you use this module, it adds the Catalyst::TraitFor::Request::REST
+    role to your request class.
 
 METHODS
     dispatch
@@ -54,6 +55,12 @@ SEE ALSO
     You likely want to look at Catalyst::Controller::REST, which implements
     a sensible set of defaults for a controller doing REST.
 
+    This class automatically adds the Catalyst::TraitFor::Request::REST role
+    to your request class. If you're writing a web application which
+    provides RESTful responses and still needs to accommodate web browsers,
+    you may prefer to use Catalyst::TraitFor::Request::REST::ForBrowsers
+    instead.
+
     Catalyst::Action::Serialize, Catalyst::Action::Deserialize
 
 TROUBLESHOOTING
@@ -76,24 +83,36 @@ AUTHOR
     (<http://www.marchex.com>)
 
 CONTRIBUTORS
-    Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+    Tomas Doran (t0m) <bobtfish@bobtfish.net>
+
+    John Goulah
 
     Christopher Laco
 
-    Luke Saunders
+    Daisuke Maki <daisuke@endeworks.jp>
 
-    John Goulah
+    Hans Dieter Pearcey
 
-    Daisuke Maki <daisuke@endeworks.jp>
+    Brian Phillips <bphillips@cpan.org>
+
+    Dave Rolsky <autarch@urth.org>
+
+    Luke Saunders
+
+    Arthur Axel "fREW" Schmidt <frioux@gmail.com>
 
     J. Shirley <jshirley@gmail.com>
 
-    Hans Dieter Pearcey
+    Gavin Henry <ghenry@surevoip.co.uk>
 
-    Tomas Doran (t0m) <bobtfish@bobtfish.net>
+    Gerv http://www.gerv.net/
+
+    Colin Newell <colin@opusvl.com>
+
+    Wallace Reis <wreis@cpan.org>
 
 COPYRIGHT
-    Copyright the above named AUTHOR and CONTRIBUTORS
+    Copyright (c) 2006-2012 the above named AUTHOR and CONTRIBUTORS
 
 LICENSE
     You may distribute this code under the same terms as Perl itself.