From: Jonathan Rockway <jon@jrock.us>
Date: Tue, 13 Oct 2009 07:18:07 +0000 (-0500)
Subject: doc fixes; 0.01 release
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=fc5720d528d00e75786cafa4213b97a79eaa8bb9;hp=4fc441ce54c886ebb468f3a2e5bf6fe8f88f7553;p=gitmo%2FMooseX-Runnable.git

doc fixes; 0.01 release
---

diff --git a/Changes b/Changes
index 90001d1..79fd289 100644
--- a/Changes
+++ b/Changes
@@ -1,2 +1,5 @@
+0.01 Tue Oct 13 02:04:03 CDT 2009
+        - stable release, no major changes
+
 0.00_01 Wed Apr 29 10:58:09 CDT 2009
         - first release
diff --git a/bin/mx-run b/bin/mx-run
index 8483eb5..726656d 100644
--- a/bin/mx-run
+++ b/bin/mx-run
@@ -72,3 +72,7 @@ __END__
 =head1 NAME
 
 mx-run - script to run MooseX::Runnable classes
+
+=head1 SEE ALSO
+
+L<MooseX::Runnable>
diff --git a/lib/MooseX/Runnable.pm b/lib/MooseX/Runnable.pm
index a2a65bd..49b8d7d 100644
--- a/lib/MooseX/Runnable.pm
+++ b/lib/MooseX/Runnable.pm
@@ -1,7 +1,7 @@
 package MooseX::Runnable;
 use Moose::Role;
 
-our $VERSION = '0.00_02';
+our $VERSION = '0.01';
 
 requires 'run';
 
@@ -54,6 +54,13 @@ let's the computer abstract away some of the tedium this entails.
 
 =head1 REQUIRED METHODS
 
+=head2 run
+
+Your class must implement C<run>.  It accepts the commandline args
+(that were not consumed by another parser, if applicable) and returns
+an integer representing the UNIX exit value.  C<return 0> means
+success.
+
 =head1 THINGS YOU GET
 
 =head2 C<mx-run>
@@ -79,3 +86,35 @@ or:
 
 If you don't want to invoke your app with C<mx-run>, you can write a
 custom version using L<MooseX::Runnable::Run|MooseX::Runnable::Run>.
+
+=head1 ARCHITECTURE
+
+C<MX::Runnable> is designed to be extensible; users can run plugins
+from the command-line, and application developers can add roles to
+their class to control behavior.
+
+For example, if you consume L<MooseX::Getopt|MooseX::Getopt>, the
+command-line will be parsed with C<MooseX::Getopt>.  Any recognized
+args will be used to instantiate your class, and any extra args will
+be passed to C<run>.
+
+=head1 BUGS
+
+Many of the plugins shipped are unstable; they may go away, change,
+break, etc.  If there is no documentation for a plugin, it is probably
+just a prototype.
+
+=head1 REPOSITORY
+
+L<http://github.com/jrockway/moosex-runnable>
+
+=head1 AUTHOR
+
+Jonathan Rockway C<< <jrockway@cpan.org> >>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2009 Jonathan Rockway
+
+This module is Free Software, you can redistribute it under the same
+terms as Perl itself.
diff --git a/lib/MooseX/Runnable/Invocation/Plugin/Debug.pm b/lib/MooseX/Runnable/Invocation/Plugin/Debug.pm
index 55f80b3..2fe011b 100644
--- a/lib/MooseX/Runnable/Invocation/Plugin/Debug.pm
+++ b/lib/MooseX/Runnable/Invocation/Plugin/Debug.pm
@@ -48,3 +48,20 @@ for my $method (qw{
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+MooseX::Runnable::Invocation::Plugin::Debug - print debugging information
+
+=head1 DESCRIPTION
+
+This is an example plugin, showing how you could write your own.  It
+prints a message for each stage of the "run" process.  It is also used
+by other plugins to determine whether or not to print debugging
+messages.
+
+=head1 SEE ALSO
+
+L<MooseX::Runnable>
diff --git a/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm b/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
index b4a806f..7bd6b72 100644
--- a/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
+++ b/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
@@ -35,3 +35,8 @@ consumed by MX::Getopt will be passed to the class's run method.
 
 (See the test C<t/basic-mx-getopt.t> for an example.)
 
+=head1 SEE ALSO
+
+L<MooseX::Runnable>
+
+L<MooseX::Getopt>
diff --git a/lib/MooseX/Runnable/Run.pm b/lib/MooseX/Runnable/Run.pm
index 765c090..5602afe 100644
--- a/lib/MooseX/Runnable/Run.pm
+++ b/lib/MooseX/Runnable/Run.pm
@@ -78,3 +78,5 @@ L<MooseX::Runnable::Invocation|MooseX::Runnable::Invocation>.
 
 L<mx-run>, a script that will run MooseX::Runnable apps, saving you
 valuable seconds!
+
+L<MooseX::Runnable>