[Jifty-commit] r5822 - jifty/trunk/lib/Jifty/Plugin/Authentication

[Jifty commits]

Author: sunnavy
Date: Fri Sep 12 13:59:16 2008
New Revision: 5822

Modified:
   jifty/trunk/lib/Jifty/Plugin/Authentication/Password.pm

Log:
add SYNOPSIS for Jifty::Plugin::Authentication::Password

Modified: jifty/trunk/lib/Jifty/Plugin/Authentication/Password.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/Authentication/Password.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/Authentication/Password.pm	Fri Sep 12 13:59:16 2008
@@ -8,6 +8,16 @@
 
 Jifty::Plugin::Authentication::Password - password authentication plugin
 
+=head1 SYNOPSIS
+
+# In your jifty config.yml under the framework section:
+
+  Plugins:
+    - LetMe: {}
+    - User: {}
+    - Authentication::Password:
+        login_by: email
+
 =head1 DESCRIPTION
 
 B<CAUTION:> This plugin is experimental.