[Bps-public-commit] r10195 - in RT-Client-Console: trunk/lib/RT/Client

[dams at bestpractical.com]

Author: dams
Date: Sun Dec 30 11:39:36 2007
New Revision: 10195

Modified:
   RT-Client-Console/   (props changed)
   RT-Client-Console/trunk/lib/RT/Client/Console.pm

Log:
 r35 at pundit:  dams | 2007-12-29 14:34:53 +0000
 updated doc


Modified: RT-Client-Console/trunk/lib/RT/Client/Console.pm
==============================================================================
--- RT-Client-Console/trunk/lib/RT/Client/Console.pm	(original)
+++ RT-Client-Console/trunk/lib/RT/Client/Console.pm	Sun Dec 30 11:39:36 2007
@@ -3,7 +3,7 @@
 use warnings;
 use strict;
 use Carp;
-our $VERSION = '0.0.3';
+our $VERSION = '0.0.4';
 
 use Params::Validate qw(:all);
 
@@ -282,124 +282,70 @@
 
 =head1 NAME
 
-RT::Client::Console - [One line description of module's purpose here]
-
-
-=head1 VERSION
-
-This document describes RT::Client::Console version 0.0.1
-
+RT::Client::Console - Text based RT console
 
 =head1 SYNOPSIS
 
-    use RT::Client::Console;
+  rtconsole [OPTIONS]
+  rtconsole --help
 
-=for author to fill in:
-    Brief code example(s) here showing commonest usage(s).
-    This section will be as far as many users bother reading
-    so make it as educational and exeplary as possible.
-  
-  
 =head1 DESCRIPTION
 
-=for author to fill in:
-    Write a full description of the module and its features here.
-    Use subsections (=head2, =head3) as appropriate.
-
-
-=head1 INTERFACE 
-
-=for author to fill in:
-    Write a separate section listing the public components of the modules
-    interface. These normally consist of either subroutines that may be
-    exported, or methods that may be called on objects belonging to the
-    classes provided by the module.
+RT::Client::Console distribution provides an executable I<rtconsole> and
+modules. The executable is ready to use and is a full-featured curses-based
+interface to any RT server that supports the REST interface.
+
+The modules provides comprehensive ways to connect, interact and display
+informations from the RT server. A plugin mechanism is planned, and will enable
+more flexibility.
 
-
-=head1 DIAGNOSTICS
+=head1 DEPENDENCIES
 
 =for author to fill in:
-    List every single error and warning message that the module can
-    generate (even the ones that will "never happen"), with a full
-    explanation of each problem, one or more likely causes, and any
-    suggested remedies.
+    A list of all the other modules that this module relies upon,
+    including any restrictions on versions, and an indication whether
+    the module is part of the standard Perl distribution, part of the
+    module's distribution, or must be installed separately. ]
 
 =over
 
-=item C<< Error message here, perhaps with %s placeholders >>
+=item Config::Tiny
 
-[Description of error here]
+=item Curses
 
-=item C<< Another error message here >>
+=item Params::Validate
 
-[Description of error here]
+=item POE
 
-[Et cetera, et cetera]
+=item Curses::Widgets
 
-=back
+=item RT::Client::REST
 
+=item Curses::Forms
 
-=head1 CONFIGURATION AND ENVIRONMENT
+=item Test::More
 
-=for author to fill in:
-    A full explanation of any configuration system(s) used by the
-    module, including the names and locations of any configuration
-    files, and the meaning of any environment variables or properties
-    that can be set. These descriptions must also include details of any
-    configuration language used.
-  
-RT::Client::Console requires no configuration files or environment variables.
+=item version
 
+=item Error
 
-=head1 DEPENDENCIES
-
-=for author to fill in:
-    A list of all the other modules that this module relies upon,
-    including any restrictions on versions, and an indication whether
-    the module is part of the standard Perl distribution, part of the
-    module's distribution, or must be installed separately. ]
-
-None.
-
-
-=head1 INCOMPATIBILITIES
-
-=for author to fill in:
-    A list of any modules that this module cannot be used in conjunction
-    with. This may be due to name conflicts in the interface, or
-    competition for system or program resources, or due to internal
-    limitations of Perl (for example, many modules that use source code
-    filters are mutually incompatible).
-
-None reported.
-
+=back
 
 =head1 BUGS AND LIMITATIONS
 
-=for author to fill in:
-    A list of known problems with the module, together with some
-    indication Whether they are likely to be fixed in an upcoming
-    release. Also a list of restrictions on the features the module
-    does provide: data types that cannot be handled, performance issues
-    and the circumstances in which they may arise, practical
-    limitations on the size of data sets, special cases that are not
-    (yet) handled, etc.
-
 No bugs have been reported.
 
 Please report any bugs or feature requests to
 C<bug-rt-client-console at rt.cpan.org>, or through the web interface at
 L<http://rt.cpan.org>.
 
-
 =head1 AUTHOR
 
-Damien "dams" Krotkine  C<< <dams at zarb.org> >>
-
+Damien "dams" Krotkine  C<< <dams at cpan.org> >>
 
 =head1 LICENCE AND COPYRIGHT
 
-Copyright (c) 2007, Damien "dams" Krotkine C<< <dams at zarb.org> >>. All rights reserved.
+Copyright (c) 2007, Damien "dams" Krotkine C<< <dams at cpan.org> >>. All rights reserved.
 
 This module is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself. See L<perlartistic>.