From: Tomas Doran <bobtfish@bobtfish.net>
Date: Fri, 3 Apr 2009 01:08:14 +0000 (+0000)
Subject: Tidy up notes about realms key in configuration, all the clues came from jayk++
X-Git-Tag: v0.10012~8
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Authentication.git;a=commitdiff_plain;h=ff87fb62a7206d93881ee1a2a269483573b12d99

Tidy up notes about realms key in configuration, all the clues came from jayk++
---

diff --git a/lib/Catalyst/Plugin/Authentication.pm b/lib/Catalyst/Plugin/Authentication.pm
index e9c918c..8119e49 100644
--- a/lib/Catalyst/Plugin/Authentication.pm
+++ b/lib/Catalyst/Plugin/Authentication.pm
@@ -799,7 +799,8 @@ new source. The rest of your application is completely unchanged.
                 };
 
 NOTE: Until version 0.10008 of this module, you would need to put all the
-realms inside a "realms" key in the configuration. That is not required anymore.
+realms inside a "realms" key in the configuration. Please see 
+L</COMPATIBILITY CONFIGURATION> for more information
 
 =over 4
 
@@ -1011,6 +1012,25 @@ configs. The changes required to update modules are relatively minor and are
 covered in L<Catalyst::Plugin::Authentication::Internals>.  We hope that most
 modules will move to the compatible list above very quickly.
 
+=head1 COMPATIBILITY CONFIGURATION
+
+Until version 0.10008 of this module, you needed to put all the
+realms inside a "realms" key in the configuration. 
+
+    # example
+    __PACKAGE__->config->{'Plugin::Authentication'} = 
+                {  
+                    default_realm => 'members',
+                    realms => {
+                        members => {
+                            ...
+                        },
+                    },
+                };
+
+If you use the old, deprecated C<< __PACKAGE__->config->{'authentication'} >>
+configuration key, then the realms key is still required.
+
 =head1 COMPATIBILITY ROUTINES
 
 In version 0.10 of L<Catalyst::Plugin::Authentication>, the API