[Jifty-commit] r7156 - jifty/trunk/lib/Jifty/Plugin

[Jifty commits]

Author: sartak
Date: Tue Jun  2 14:16:53 2009
New Revision: 7156

Modified:
   jifty/trunk/lib/Jifty/Plugin/SetupWizard.pm

Log:
Add POD for SetupWizard

Modified: jifty/trunk/lib/Jifty/Plugin/SetupWizard.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/SetupWizard.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/SetupWizard.pm	Tue Jun  2 14:16:53 2009
@@ -54,3 +54,44 @@
 
 1;
 
+__END__
+
+=head1 NAME
+
+Jifty::Plugin::SetupWizard - make it easy for end-users to set up your app
+
+=head1 DESCRIPTION
+
+    http://your.app/__jifty/admin/setupwizard
+
+=head1 USAGE
+
+Add the following to your site_config.yml
+
+ framework:
+   Plugins:
+     - SetupWizard: {}
+
+=head1 METHODS
+
+=head2 init
+
+Sets up a L</post_init> hook.
+
+=head2 add_step(%params)
+
+Adds another step to the setup wizard. It will go at the end, but before the
+"finalize" step if it exists.
+
+=head2 prereq_plugins
+
+This plugin depends on L<Jifty::Plugin::Config>.
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2007-2009 Best Practical Solutions
+
+This is free software and may be modified and distributed under the same terms as Perl itself.
+
+=cut
+