Fix plugin links in POD

[catagits/Catalyst-View-Component-SubInclude.git] / README

diff --git a/README b/README
index 355b9aa..0cfd4b7 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ NAME
     views
 
 VERSION
-    Version 0.08
+    Version 0.11
 
 SYNOPSIS
       package MyApp::View::TT;
@@ -30,8 +30,7 @@ DESCRIPTION
 
     It's built in an extensible way so that you're free to use sub-requests,
     Varnish ESI (<http://www.catalystframework.org/calendar/2008/17>) or any
-    other sub-include plugin you might want to implement. An LWP plugin
-    seems useful and might be developed in the future.
+    other sub-include plugin you might want to implement.
 
 STASH FUNCTIONS
     This component does its magic by exporting a "subinclude" coderef entry
@@ -57,11 +56,25 @@ SUBINCLUDE PLUGINS
     the view's configuration options (either in the config file or in the
     view module itself).
 
-    Configuration file example:
-
-      <View::TT>
-          subinclude_plugin   ESI
-      </View::TT>
+        __PACKAGE__->config(
+            subinclude_plugin => 'ESI',
+            subinclude => {
+                'SubRequest' => {
+                    keep_stash => 1,
+                },
+                'HTTP::POST' => {
+                    class => 'HTTP',
+                    http_method => 'POST',
+                    ua_timeout => '10',
+                    uri_map => {
+                        '/foo/' => 'http://www.foo.com/',
+                    },
+                },
+            },
+        );
+
+    You can change each plugins' configuration through the keys in the
+    'subinclude' config key (example above)
 
   "set_subinclude_plugin( $plugin )"
     This method changes the current active subinclude plugin in runtime. It
@@ -99,6 +112,10 @@ AUTHOR
 CONTRIBUTORS
     Tomas Doran (t0m) "<bobtfish@bobtfish.net".
 
+    Vladimir Timofeev, "<vovkasm at gmail.com>".
+
+    Wallace Reis (wreis) "<wreis@cpan.org>".
+
 SPONSORSHIP
     Development sponsored by Ionzero LLC <http://www.ionzero.com/>.