improved cgi engine docs

diff --git a/Changes b/Changes
index f33a5c3..6079fda 100644 (file)
--- a/Changes
+++ b/Changes
@@ -2,6 +2,7 @@ This file documents the revision history for Perl extension Catalyst.
 
 4.25  Sat Mar 12 18:00:00 2005
         - correct perl pathes for helper generated scripts (Tatsuhiko Miyagawa)
+        - improved cgi engine docs (Christoper Hicks)
 
 4.24  Sat Mar 12 01:00:00 2005
         - updated cookbook example  

diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm
index 10a4c99..e9c8092 100644 (file)
--- a/lib/Catalyst.pm
+++ b/lib/Catalyst.pm
@@ -197,9 +197,9 @@ Sebastian Riedel, C<sri@oook.de>
 
 =head1 THANK YOU
 
-Andrew Ruthven, Danijel Milicevic, David Naughton, Gary Ashton Jones,
-Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa
-and all the others who've helped.
+Andrew Ruthven, Christopher Hicks, Danijel Milicevic, David Naughton,
+Gary Ashton Jones, Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg,
+Tatsuhiko Miyagawa and all the others who've helped.
 
 =head1 LICENSE
 

diff --git a/lib/Catalyst/Engine/CGI.pm b/lib/Catalyst/Engine/CGI.pm
index 6180550..e682f6e 100644 (file)
--- a/lib/Catalyst/Engine/CGI.pm
+++ b/lib/Catalyst/Engine/CGI.pm
@@ -18,12 +18,27 @@ Catalyst::Engine::CGI - The CGI Engine
 
 =head1 SYNOPSIS
 
+    #!/usr/bin/perl -w
+
+    use strict;
+    use lib '/path/to/MyApp/lib';
+    use MyApp;
+
+    MyApp->run;
+
 See L<Catalyst>.
 
 =head1 DESCRIPTION
 
 This is the CGI engine for Catalyst.
 
+The script shown above must be designated as a "Non-parsed Headers"
+script to function properly.
+To do this in Apache name the script starting with C<nph->.
+
+The performance of this way of using Catalyst is not expected to be
+useful in production applications, but it may be helpful for development.
+
 =head2 METHODS
 
 =head3 run