From eb2bdba0d89c81c25b728f6aecbb4a423b60494b Mon Sep 17 00:00:00 2001
From: "Paul Buetow (lxpbuetowlap.united.domain)" <paul.buetow@1und1.de>
Date: Sun, 16 Mar 2014 14:45:29 +0100
Subject: some more documentation

---
 docs/japi.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'docs/japi.txt')

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
-- 
cgit v1.2.3