X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=5aa8638924da71264d46ad8d9f9a02e743c10d4d;hb=6f6e1bb4c351b3983846bec8c4540bbbcf38a480;hp=8c088092a0eac825ad9e98835a152ae6b33978f6;hpb=d01df17df2888c322ad8047d40da81271b25ce59;p=catagits%2FCatalyst-Runtime.git

diff --git a/README b/README
index 8c08809..5aa8638 100644
--- a/README
+++ b/README
@@ -17,8 +17,6 @@ SYNOPSIS
         # command line interface
         script/test.pl /yada
 
-        See also L<Catalyst::Manual::Intro>
-
         use Catalyst;
 
         use Catalyst qw/My::Module My::OtherModule/;
@@ -27,23 +25,21 @@ SYNOPSIS
 
         use Catalyst qw/-Debug -Engine=CGI/;
 
-        __PACKAGE__->action( '!default' => sub { $_[1]->res->output('Hello') } );
+        sub default : Private { $_[1]->res->output('Hello') } );
+
+        sub index : Path('/index.html') {
+            my ( $self, $c ) = @_;
+            $c->res->output('Hello');
+            $c->forward('foo');
+        }
 
-        __PACKAGE__->action(
-            'index.html' => sub {
-                my ( $self, $c ) = @_;
-                $c->res->output('Hello');
-                $c->forward('_foo');
-            }
-        );
+        sub product : Regex('^product[_]*(\d*).html$') {
+            my ( $self, $c ) = @_;
+            $c->stash->{template} = 'product.tt';
+            $c->stash->{product} = $c->req->snippets->[0];
+        }
 
-        __PACKAGE__->action(
-            '/^product[_]*(\d*).html$/' => sub {
-                my ( $self, $c ) = @_;
-                $c->stash->{template} = 'product.tt';
-                $c->stash->{product} = $c->req->snippets->[0];
-            }
-        );
+    See also Catalyst::Manual::Intro
 
 DESCRIPTION
     Catalyst is based upon Maypole, which you should consider for smaller
@@ -53,49 +49,100 @@ DESCRIPTION
 
     See Catalyst::Manual for more documentation.
 
-    Omit the Catalyst::Plugin:: prefix from plugins. So
-    Catalyst::Plugin::My::Module becomes My::Module.
+    Catalyst plugins can be loaded by naming them as arguments to the "use
+    Catalyst" statement. Omit the "Catalyst::Plugin::" prefix from the
+    plugin name, so "Catalyst::Plugin::My::Module" becomes "My::Module".
 
         use Catalyst 'My::Module';
 
-    You can also set special flags like -Debug and -Engine.
+    Special flags like -Debug and -Engine can also be specifed as arguments
+    when Catalyst is loaded:
 
         use Catalyst qw/-Debug My::Module/;
 
     The position of plugins and flags in the chain is important, because
-    they are loaded in the same order they appear.
+    they are loaded in exactly the order that they appear.
 
-  -Debug
-        use Catalyst '-Debug';
+    The following flags are supported:
 
-    is equivalent to
+    -Debug
+        enables debug output, i.e.:
 
-        use Catalyst;
-        sub debug { 1 }
+            use Catalyst '-Debug';
+
+        this is equivalent to:
+
+            use Catalyst;
+            sub debug { 1 }
+
+    -Engine
+        Force Catalyst to use a specific engine. Omit the
+        "Catalyst::Engine::" prefix of the engine name, i.e.:
+
+            use Catalyst '-Engine=CGI';
+
+METHODS
+    debug
+        Overload to enable debug messages.
+
+    config
+        Returns a hashref containing your applications settings.
+
+    $c->engine
+        Contains the engine class.
+
+    $c->log
+        Contains the logging object. Unless it is already set Catalyst sets
+        this up with a "Catalyst::Log" object. To use your own log class:
+
+            $c->log( MyLogger->new );
+            $c->log->info("now logging with my own logger!");
+
+        Your log class should implement the methods described in the
+        "Catalyst::Log" man page.
+
+    $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;
+
+LIMITATIONS
+    mod_perl2 support is considered experimental and may contain bugs.
+
+SUPPORT
+    IRC:
+
+        Join #catalyst on irc.perl.org.
 
-  -Engine
-    Force Catalyst to use a specific engine. Omit the Catalyst::Engine::
-    prefix.
+    Mailing-Lists:
 
-        use Catalyst '-Engine=CGI';
+        http://lists.rawmode.org/mailman/listinfo/catalyst
+        http://lists.rawmode.org/mailman/listinfo/catalyst-dev
 
-  METHODS
-   debug
-    Overload to enable debug messages.
+    Web:
 
-   config
-    Returns a hashref containing your applications settings.
+        http://catalyst.perl.org
 
 SEE ALSO
-    Catalyst::Manual, Catalyst::Test, Catalyst::Request, Catalyst::Response,
-    Catalyst::Engine
+    Catalyst::Manual - The Catalyst Manual
+    Catalyst::Engine - Core Engine
+    Catalyst::Log - The Log Class.
+    Catalyst::Request - The Request Object
+    Catalyst::Response - The Response Object
+    Catalyst::Test - The test suite.
 
 AUTHOR
     Sebastian Riedel, "sri@oook.de"
 
 THANK YOU
-    Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse Sheidlower,
-    Johan Lindstrom, Marcus Ramberg and all the others who've helped.
+    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, Tatsuhiko
+    Miyagawa and all the others who've helped.
 
 LICENSE
     This library is free software . You can redistribute it and/or modify it