some more documentation

5 files changed, 33 insertions, 0 deletions

diff --git a/README.txt b/README.txt
index 9096b46..2f4225d 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,16 @@
 NAME
     japi - A Humble Jira API Tool
 
+    This is a small and simple command line tool to be used manually or via
+    cron to fetch the newest unresolved and unclosed tickets from a Jira
+    project.
+
+    It might be usefull to write the results every hour to a local file and
+    do a "cat ~/.issues" every time you open a new shell.
+
+    CAUTION: You may also need to install the "JIRA::REST" module from CPAN
+    manually. It's not included in standard Debian GNU/Linux Wheezy yet.
+
 SYNOPSIS
     Synopsis: japi [--debug] [--help] [--version] [--passfile]
     [--jira_apiversion <STRING>] [--jira_query <STRING>] [--jira_uribase
diff --git a/docs/japi.1 b/docs/japi.1
index c7d4a7a..bd29ae0 100644
--- a/docs/japi.1
+++ b/docs/japi.1
@@ -131,6 +131,12 @@
 .nh
 .SH "NAME"
 japi \- A Humble Jira API Tool
+.PP
+This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project.
+.PP
+It might be usefull to write the results every hour to a local file and do a "cat ~/.issues" every time you open a new shell.
+.PP
+CAUTION: You may also need to install the "JIRA::REST" module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet.
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 Synopsis: japi
diff --git a/docs/japi.pod b/docs/japi.pod
index b38fd45..41a0a05 100644
--- a/docs/japi.pod
+++ b/docs/japi.pod
@@ -2,6 +2,12 @@
 
 japi - A Humble Jira API Tool
 
+This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project. 
+
+It might be usefull to write the results every hour to a local file and do a C<cat ~/.issues> every time you open a new shell.
+
+CAUTION: You may also need to install the C<JIRA::REST> module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet.
+
 =head1 SYNOPSIS
 
 Synopsis: japi
diff --git a/docs/japi.txt b/docs/japi.txt
index 9096b46..2f4225d 100644
--- a/docs/japi.txt
+++ b/docs/japi.txt
@@ -1,6 +1,16 @@
 NAME
     japi - A Humble Jira API Tool
 
+    This is a small and simple command line tool to be used manually or via
+    cron to fetch the newest unresolved and unclosed tickets from a Jira
+    project.
+
+    It might be usefull to write the results every hour to a local file and
+    do a "cat ~/.issues" every time you open a new shell.
+
+    CAUTION: You may also need to install the "JIRA::REST" module from CPAN
+    manually. It's not included in standard Debian GNU/Linux Wheezy yet.
+
 SYNOPSIS
     Synopsis: japi [--debug] [--help] [--version] [--passfile]
     [--jira_apiversion <STRING>] [--jira_query <STRING>] [--jira_uribase
diff --git a/src/japi b/src/japi
index 644ef42..2b2ec8a 100755
--- a/src/japi
+++ b/src/japi
@@ -26,6 +26,7 @@ package Japi::Japi {
     my $self = shift;
 
     # Prepare the option has for GetOptions, type '' is default type bool
+    # Also set some default values.
     my %opts = (
       # General options
       version  => { type => '',   value => 0 },