From: Rafael Kitover <rkitover@cpan.org>
Date: Thu, 21 Jan 2010 22:36:25 +0000 (+0000)
Subject: minor documentation updates
X-Git-Tag: v0.08119~9^2~13
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=commitdiff_plain;h=47442cea7c22e54caa51066b90c489e58b9bd71d

minor documentation updates
---

diff --git a/Makefile.PL b/Makefile.PL
index 2715d8e..a6963d4 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -63,6 +63,7 @@ my %admin_requires = (
   'parent'                     => '0.223',
   'JSON::Any'                  => '0',
   'Getopt::Long::Descriptive'  => '0.081',
+  'Text::CSV_XS'               => '0.70',
 );
 
 #************************************************************************#
diff --git a/lib/DBIx/Class/Admin.pm b/lib/DBIx/Class/Admin.pm
index 318dd87..f3be3c9 100644
--- a/lib/DBIx/Class/Admin.pm
+++ b/lib/DBIx/Class/Admin.pm
@@ -40,6 +40,16 @@ DBIx::Class::Admin - Administration object for schemas
 
 =head1 SYNOPSIS
 
+  $ dbicadmin --help
+
+  $ dbicadmin --schema=MyApp::Schema \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --deploy
+
+  $ dbicadmin --schema=MyApp::Schema --class=Employee \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --op=update --set='{"name":"New_Employee"}'
+
   use DBIx::Class::Admin;
 
   # ddl manipulation
@@ -61,6 +71,30 @@ DBIx::Class::Admin - Administration object for schemas
   # install a version for an unversioned schema
   $admin->install("3.0");
 
+=head1 REQUIREMENTS
+
+The following CPAN modules are required to use C<dbicadmin> and this module:
+
+L<Moose>
+
+L<MooseX::Types>
+
+L<MooseX::Types::JSON>
+
+L<MooseX::Types::Path::Class>
+
+L<Try::Tiny>
+
+L<parent>
+
+L<JSON::Any>
+
+L<namespace::autoclean>
+
+L<Getopt::Long::Descriptive>
+
+L<Text::CSV>
+
 =head1 Attributes
 
 =head2 schema_class
@@ -554,7 +588,7 @@ sub _find_stanza {
   return $cfg;
 }
 
-=head1 AUTHORS
+=head1 AUTHOR
 
 See L<DBIx::Class/CONTRIBUTORS>.