Merge pull request #13 from einhverfr/master

Documentation changes for 0.03

Changes

@@ -1,5 +1,8 @@
 Revision history for App-LedgerSMB-Admin
 
-0.01    Date/time
+0.03	2014-10-10
+	Documentation fixes, streamlining of module, looking forward.
+
+0.01    2014
         First version, released on an unsuspecting world.
 

Makefile.PL

@@ -31,4 +31,14 @@ WriteMakefile(
     },
     dist  => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
     clean => { FILES => 'App-LedgerSMB-Admin-*' },
+    META_MERGE => {
+       'meta-spec' => { version => 2 },
+        resources => {
+           repository => {
+             type => 'git',
+             url  => 'https://github.com/dwimperl/Task-DWIM.git',
+             web  => 'https://github.com/dwimperl/Task-DWIM',
+           },
+       },
+    },
 );

README

@@ -1,16 +1,7 @@
 App-LedgerSMB-Admin
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
-
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it to get an idea of the module's uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
-
+This package provides command-line LedgerSMB administration utilities which work
+on multiple major versions of that ERP.
 
 INSTALLATION
 

lib/App/LedgerSMB/Admin.pm

@@ -10,28 +10,26 @@ App::LedgerSMB::Admin - Easily Manage LedgerSMB Installations
 
 =head1 VERSION
 
-Version 0.02
+Version 0.03
 
 =cut
 
-our $VERSION = '0.02';
+our $VERSION = '0.03';
 
 
 =head1 SYNOPSIS
 
 This module provides the basic routines for managing multiple major versions of
 LedgerSMB through a consistent toolkit.
 
-It contains basically three components:
+It contains basically two components:
 
 =over
 
 =item command line scripts
 
 =item libraries for writing management programs
 
-=item dancer-based web application (Forthcoming)
-
 =back
 
 =head1 BUNDLED CLI PROGRAMS
@@ -84,8 +82,25 @@ rebuilding stored procedures and permissions of a LedgerSMB 1.3 or 1.4 database.
    --username postgres      Database Superuser to Log In As
    --prompt-password        Prompt for Password (can use PGPASSWORD instead)
 
+=head1 Bundled Libraries
+
+=head2 App::LedgerSMB::Admin
+
+Provides base version tracking and management routines
+
+=head2 App::LedgerSMB::Admin::Database
+
+Routines to reload, create, update, backup, and restore databases
+
+=head2 App::LedgerSMB::Admin::Database::Setting
+
+Look up settings in a LedgerSMB database
+
+=head2 App::LedgerSMB::Admin::User
+
+Undeveloped, but will include basic user management routines.
 
-=head1 LIBRARY SUBROUTINES/METHODS
+=head1 SUBROUTINES/METHODS of This Library
 
 =head2 add_paths(%versionhash)
 

lib/App/LedgerSMB/Admin/Database.pm

@@ -33,11 +33,11 @@ Upgrading to 1.4 from 1.3, after updating 1.3 instance to latest:
 
 =head1 VERSION
 
-0.02
+0.03
 
 =cut
 
-our $VERSION=0.02;
+our $VERSION=0.03;
 
 =head1 PROPERTIES INHERITED FROM PGObject::Util::DBAdmin
 

t/00-load.t

@@ -4,15 +4,13 @@ use strict;
 use warnings FATAL => 'all';
 use Test::More;
 
-plan tests => 6;
+plan tests => 4;
 
 BEGIN {
     use_ok( 'App::LedgerSMB::Admin' ) || print "Bail out!\n";
     use_ok( 'App::LedgerSMB::Admin::Database' );
     use_ok( 'App::LedgerSMB::Admin::Database::Setting' );
-    use_ok( 'App::LedgerSMB::Admin::Database::Routings' );
     use_ok( 'App::LedgerSMB::Admin::User' );
-    use_ok( 'App::LedgerSMB::Admin::Auth' );
 }
 
 diag( "Testing App::LedgerSMB::Admin $App::LedgerSMB::Admin::VERSION, Perl $], $^X" );

t/boilerplate.t

@@ -38,8 +38,6 @@ sub module_boilerplate_ok {
     );
 }
 
-TODO: {
-  local $TODO = "Need to replace the boilerplate text";
 
   not_in_file_ok(README =>
     "The README is used..."       => qr/The README is used/,
@@ -52,6 +50,3 @@ TODO: {
 
   module_boilerplate_ok('lib/App/LedgerSMB/Admin.pm');
 
-
-}
-