Version 0.17

[catagits/Catalyst-Plugin-SubRequest.git] / README

diff --git a/README b/README
index 71c61f0..cebed77 100644 (file)
--- a/README
+++ b/README
@@ -4,23 +4,52 @@ NAME
 SYNOPSIS
         use Catalyst 'SubRequest';
 
-        $c->subreq('/test/foo/bar', { template => 'magic.tt' });
+        my $res_body = $c->subreq('/test/foo/bar', { template => 'magic.tt' });
 
-        $c->subreq(        {       path            => '/test/foo/bar',
-                           body            => $body        },
-                   {       template        => 'magic.tt'           });
+        my $res_body = $c->subreq( {
+           path            => '/test/foo/bar',
+           body            => $body
+        }, {
+           template        => 'magic.tt'
+        });
+
+        # Get the full response object
+        my $res = $c->subreq_res('/test/foo/bar', {
+            template => 'mailz.tt'
+        }, {
+            param1   => 23
+        });
+        $c->log->warn( $res->content_type );
 
 DESCRIPTION
     Make subrequests to actions in Catalyst. Uses the catalyst dispatcher,
-    so it will work like an external url call.
+    so it will work like an external url call. Methods are provided both to
+    get the body of the response and the full response (Catalyst::Response)
+    object.
 
 METHODS
     subreq [path as string or hash ref], [stash as hash ref], [parameters as
     hash ref]
+    subrequest
     sub_request
-        Takes a full path to a path you'd like to dispatch to. If the path
-        is passed as a hash ref then it can include body, action, match and
-        path. Any additional parameters are put into the stash.
+        Takes a full path to a path you'd like to dispatch to.
+
+        If the path is passed as a hash ref then it can include body,
+        action, match and path.
+
+        An optional second argument as hashref can contain data to put into
+        the stash of the subrequest.
+
+        An optional third argument as hashref can contain data to pass as
+        parameters to the subrequest.
+
+        Returns the body of the response.
+
+    subreq_res [path as string or hash ref], [stash as hash ref],
+    [parameters as hash ref]
+    subrequest_response
+    sub_request_response
+        Like "sub_request()", but returns a full Catalyst::Response object.
 
 SEE ALSO
     Catalyst.
@@ -34,7 +63,7 @@ THANK YOU
     SRI, for writing the awesome Catalyst framework
 
 COPYRIGHT
-    Copyright (c) 2005 - 2008 the Catalyst::Plugin::SubRequest "AUTHORS" as
+    Copyright (c) 2005 - 2011 the Catalyst::Plugin::SubRequest "AUTHORS" as
     listed above.
 
 LICENSE