1 files changed, 86 insertions, 0 deletions
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..8a080af
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,86 @@
+=head1 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 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
+  [--debug]
+  [--help]
+  [--version]
+  [--nocolor]
+  [--passfile]
+  [--unassigned]
+  [--jira_apiversion STRING]
+  [--jira_query STRING]
+  [--jira_uribase STRING]
+  [--jira_user STRING]
+
+=head2 Options:
+
+=over 
+
+=item --debug
+
+Prints out extra debugging infos during execution. 
+
+=item --help
+
+Prints out the help.
+
+=item --version
+
+Prints out the version.
+
+=item --nocolor
+
+By default the output uses colored text output. This switch disables it.
+
+=item --passfile STRING
+
+Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is C<~/.japipass>.
+
+If the file is not present, Japi will prompt for the password. 
+
+=item --unassigned
+
+By default the output lists assigned and unassigned issues. Use this switch to only list unassigned issues. 
+
+=item --jira_apiversion STRING
+
+Specifies the Jira API version to use. The default value is C<rest/api/2>.
+
+=item --jira_query STRING
+
+Specifies the Jira search string (e.q. a JQL string). The default value is C<search?jql=project=MT and status not in (Resolved,Closed)>.
+
+=item --jira_uribase STRING
+
+Specifies the Jira URI base. The default value is C<https://your-jira.example.com>. This has to be changed.
+
+=item --jira_user STRING
+
+Specifies the Jira user. The default value is your current Linux/UNIX user.
+
+=back
+
+=head1 CONFIG
+
+Almost all options have to be passed the Japi tool via command line. One exception is the password file containing your Jira password Base64 encoded.
+
+It can be created like this:
+
+  bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass
+  chmod 0600 ~/.japipass
+
+=head1 AUTHOR
+
+Paul C. Buetow - <paul@buetow.org>
+
+=cut