add minimum perl

[catagits/CatalystX-Declare.git] / README

diff --git a/README b/README
index a2ef93e..d9cb94e 100644 (file)
--- a/README
+++ b/README
@@ -11,6 +11,9 @@ SYNOPSIS
             $CLASS->config(name => 'My Declarative Web Application');
         }
 
+    See also: CatalystX::Declare::Keyword::Application, "class" in
+    MooseX::Declare
+
   Controllers
         use CatalystX::Declare;
 
@@ -30,7 +33,7 @@ SYNOPSIS
             method _build_welcome_message { 'Welcome' }
         
         
-            action base as '';
+            action base under '/' as '';
         
             under base {
             
@@ -40,6 +43,10 @@ SYNOPSIS
             }
         }
 
+    See also: CatalystX::Declare::Keyword::Controller,
+    CatalystX::Declare::Keyword::Action,
+    CatalystX::Declare::Keyword::Component, "class" in MooseX::Declare
+
   Roles
         use CatalystX::Declare;
 
@@ -65,7 +72,40 @@ SYNOPSIS
             }
         }
 
+    See also: CatalystX::Declare::Keyword::Role,
+    CatalystX::Declare::Keyword::Action, "class" in MooseX::Declare
+
+  Views
+        use CatalystX::Declare;
+
+        view MyApp::Web::View::TT
+            extends Catalyst::View::TT {
+
+            $CLASS->config(
+                TEMPLATE_EXTENSION => '.html',
+            );
+        }
+
+    See also: CatalystX::Declare::Keyword::View,
+    CatalystX::Declare::Keyword::Component, "class" in MooseX::Declare
+
+  Models
+        use CatalystX::Declare;
+
+        model MyApp::Web::Model::DBIC::Schema
+            extends Catalyst::Model::DBIC::Schema {
+
+            $CLASS->config(
+                schema_class => 'MyApp::Schema',
+            );
+        }
+
+    See also: CatalystX::Declare::Keyword::Model,
+    CatalystX::Declare::Keyword::Component, "class" in MooseX::Declare
+
 DESCRIPTION
+    This module is EXPERIMENTAL
+
     This module provides a declarative syntax for Catalyst applications. Its
     main focus is currently on common and repetitious parts of the
     application, such as the application class itself, controllers, and
@@ -84,9 +124,11 @@ DESCRIPTION
     with this module's syntax extensions:
 
     CatalystX::Declare::Keyword::Application
-    CatalystX::Declare::Keyword::Controller
     CatalystX::Declare::Keyword::Action
+    CatalystX::Declare::Keyword::Controller
     CatalystX::Declare::Keyword::Role
+    CatalystX::Declare::Keyword::View
+    CatalystX::Declare::Keyword::Model
 
     Things like models, views, roles for request or response objects, can be
     built declaratively with MooseX::Declare, which is used to additionally
@@ -102,7 +144,7 @@ DESCRIPTION
 
         controller MyApp::Web::Controller::Baz {
 
-            final action qux { 
+            final action qux under '/' { 
                 $ctx->response->body(Foo->new->bar) 
             }
         }