added synopsis to Engine subclassed and documented a couple of methods to make podcov...

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Engine / Server.pm

diff --git a/lib/Catalyst/Engine/Server.pm b/lib/Catalyst/Engine/Server.pm
index 468494d..20c0bcc 100644 (file)
--- a/lib/Catalyst/Engine/Server.pm
+++ b/lib/Catalyst/Engine/Server.pm
@@ -9,7 +9,19 @@ Catalyst::Engine::Server - Catalyst Server Engine
 
 =head1 SYNOPSIS
 
-See L<Catalyst>.
+A script using the Catalyst::Engine::Server module might look like:
+
+    #!/usr/bin/perl -w
+
+    BEGIN { 
+       $ENV{CATALYST_ENGINE} = 'Server';
+    }
+
+    use strict;
+    use lib '/path/to/MyApp/lib';
+    use MyApp;
+
+    MyApp->run;
 
 =head1 DESCRIPTION