Version 0.07

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

diff --git a/README b/README
index 400bcf4..ec16a7a 100644 (file)
--- a/README
+++ b/README
@@ -3,21 +3,28 @@ NAME
 
 SYNOPSIS
         # in MyApp.pm
-        use Catalyst;
-        MyApp->setup( qw/RequireSSL/ );
-    
-        MyApp->config->{require_ssl} = {
-            https => 'secure.mydomain.com',
-            http => 'www.mydomain.com',
-            remain_in_ssl => 0,
-            no_cache => 0,
-            detach_on_redirect => 1,
-        };
+        use Catalyst qw/
+            RequireSSL
+        /;
+        __PACKAGE__->config(
+            require_ssl => {
+                https => 'secure.mydomain.com',
+                http => 'www.mydomain.com',
+                remain_in_ssl => 0,
+                no_cache => 0,
+                detach_on_redirect => 1,
+            },
+        );
+        __PACKAGE__->setup;
+
 
         # in any controller methods that should be secured
         $c->require_ssl;
 
 DESCRIPTION
+    Note: This module is considered to be deprecated for most purposes.
+    Consider using Catalyst::ActionRole::RequireSSL instead.
+
     Use this plugin if you wish to selectively force SSL mode on some of
     your web pages, for example a user login form or shopping cart.
 
@@ -102,7 +109,8 @@ KNOWN ISSUES
     static files directly from your web server.
 
 SEE ALSO
-    Catalyst, Catalyst::Plugin::Static::Simple
+    Catalyst, Catalyst::ActionRole::RequireSSL,
+    Catalyst::Plugin::Static::Simple
 
 AUTHOR
     Andy Grundman, <andy@hybridized.org>