tweak to $c->req->full_uri
[catagits/Catalyst-Runtime.git] / README
diff --git a/README b/README
index de2defe..58c0b27 100644 (file)
--- a/README
+++ b/README
@@ -7,15 +7,15 @@ SYNOPSIS
         cd MyApp
 
         # add models, views, controllers
-        script/create.pl model Something
-        script/create.pl view Stuff
-        script/create.pl controller Yada
+        script/myapp_create.pl model Something
+        script/myapp_create.pl view Stuff
+        script/myapp_create.pl controller Yada
 
         # built in testserver
-        script/server.pl
+        script/myapp_server.pl
 
         # command line interface
-        script/test.pl /yada
+        script/myapp_test.pl /yada
 
         use Catalyst;
 
@@ -30,10 +30,10 @@ SYNOPSIS
         sub index : Path('/index.html') {
             my ( $self, $c ) = @_;
             $c->res->output('Hello');
-            $c->forward('_foo');
+            $c->forward('foo');
         }
 
-        sub product : Regex('/^product[_]*(\d*).html$/') {
+        sub product : Regex('^product[_]*(\d*).html$') {
             my ( $self, $c ) = @_;
             $c->stash->{template} = 'product.tt';
             $c->stash->{product} = $c->req->snippets->[0];
@@ -42,9 +42,6 @@ SYNOPSIS
     See also Catalyst::Manual::Intro
 
 DESCRIPTION
-    Catalyst is based upon Maypole, which you should consider for smaller
-    projects.
-
     The key concept of Catalyst is DRY (Don't Repeat Yourself).
 
     See Catalyst::Manual for more documentation.
@@ -101,12 +98,24 @@ METHODS
         Your log class should implement the methods described in the
         "Catalyst::Log" man page.
 
-LIMITATIONS
-    FCGI and mod_perl2 support are considered experimental and may contain
-    bugs.
+    $c->plugin( $name, $class, @args )
+        Instant plugins for Catalyst. Classdata accessor/mutator will be
+        created, class loaded and instantiated.
+
+            MyApp->plugin( 'prototype', 'HTML::Prototype' );
+
+            $c->prototype->define_javascript_functions;
+
+CASE SENSITIVITY
+    By default Catalyst is not case sensitive, so "MyApp::C::FOO::Bar"
+    becomes "/foo/bar".
 
-    You may encounter problems accessing the built in test server on public
-    ip addresses on the internet, thats because of a bug in HTTP::Daemon.
+    But you can activate case sensitivity with a config parameter.
+
+        MyApp->config->{case_sensitive} = 1;
+
+LIMITATIONS
+    mod_perl2 support is considered experimental and may contain bugs.
 
 SUPPORT
     IRC:
@@ -118,6 +127,10 @@ SUPPORT
         http://lists.rawmode.org/mailman/listinfo/catalyst
         http://lists.rawmode.org/mailman/listinfo/catalyst-dev
 
+    Web:
+
+        http://catalyst.perl.org
+
 SEE ALSO
     Catalyst::Manual - The Catalyst Manual
     Catalyst::Engine - Core Engine
@@ -126,15 +139,54 @@ SEE ALSO
     Catalyst::Response - The Response Object
     Catalyst::Test - The test suite.
 
+CREDITS
+    Andy Grundman
+
+    Andrew Ford
+
+    Andrew Ruthven
+
+    Autrijus Tang
+
+    Christian Hansen
+
+    Christopher Hicks
+
+    Dan Sully
+
+    Danijel Milicevic
+
+    David Naughton
+
+    Gary Ashton Jones
+
+    Geoff Richards
+
+    Jesse Sheidlower
+
+    Jody Belka
+
+    Johan Lindstrom
+
+    Juan Camacho
+
+    Leon Brocard
+
+    Marcus Ramberg
+
+    Matt S Trout
+
+    Robert Sedlacek
+
+    Sebastian Riedel
+
+    Tatsuhiko Miyagawa
+
+    Ulf Edvinsson
+
 AUTHOR
     Sebastian Riedel, "sri@oook.de"
 
-THANK YOU
-    Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks, Dan
-    Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse
-    Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa and all
-    the others who've helped.
-
 LICENSE
     This library is free software . You can redistribute it and/or modify it
     under the same terms as perl itself.