X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=d922019d4733dedbce8a35a999658ecee2066791;hb=a6ea100c21d7328721a82a7a7f8ef3b0bc0f2172;hp=1f632d2be815a31b4d964b23fea71828191e4bbf;hpb=79dc6a687cf0fd8be10907915a6a12018eff9e5a;p=catagits%2FCatalyst-Plugin-Authentication.git diff --git a/README b/README index 1f632d2..d922019 100644 --- a/README +++ b/README @@ -151,7 +151,7 @@ EXAMPLE } } }; - + This tells the authentication plugin what realms are available, which credential and store modules are used, and the configuration of each. With this code loaded, we can now attempt to authenticate users. @@ -296,23 +296,20 @@ CONFIGURATION authserver => '192.168.10.17' } } - - } + + } }; - use_session - + use_session Whether or not to store the user's logged in state in the session, if the application is also using Catalyst::Plugin::Session. This value is set to true per default. - default_realm - + default_realm This defines which realm should be used as when no realm is provided to methods that require a realm such as authenticate or find_user. - realms - + realms This contains the series of realm configurations you want to use for your app. The only rule here is that there must be at least one. A realm consists of a name, which is used to reference the realm, a @@ -393,7 +390,7 @@ INTERNAL METHODS get_auth_realm ( $realmname ) Retrieves the realm instance for the realmname provided. - + * SEE ALSO This list might not be up to date. Below are modules known to work with @@ -503,11 +500,3 @@ COPYRIGHT & LICENSE reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. -POD ERRORS - Hey! The above document had some coding errors, which are explained - below: - - Around line 672: - You can't have =items (as at line 706) unless the first thing after - the =over is an =item -