summaryrefslogtreecommitdiff
path: root/docs/japi.txt
diff options
context:
space:
mode:
authorPaul Buetow (lxpbuetowlap.united.domain) <paul.buetow@1und1.de>2014-03-16 14:45:29 +0100
committerPaul Buetow (lxpbuetowlap.united.domain) <paul.buetow@1und1.de>2014-03-16 14:45:29 +0100
commiteb2bdba0d89c81c25b728f6aecbb4a423b60494b (patch)
tree48eeb2035feb29e3d4aea4cb3156f057a3164121 /docs/japi.txt
parent50b05a273f6989b19d40971b79061883b0e7eced (diff)
some more documentation
Diffstat (limited to 'docs/japi.txt')
-rw-r--r--docs/japi.txt10
1 files changed, 10 insertions, 0 deletions
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