git.fiddlerwoaroof.com
Browse code

Update README.txt with information about the cli app built

fiddlerwoaroof authored on 18/04/2016 21:56:16
Showing 1 changed files
... ...
@@ -1,2 +1,24 @@
1
-An implementation of part of JIRA's API and a simple client for listing and searching issues.
1
+An implementation of part of JIRA's API and a simple client for listing and
2
+searching issues.
2 3
 
4
+If you have a sane lisp environment setup (only SBCL tested, at the moment)
5
+with Quicklisp, running test-client.lisp should produce an executable:
6
+
7
+```
8
+Usage: jira-client [-ihv] [OPTIONS] ARGUMENTS...
9
+
10
+A command line client for Jira issues
11
+Main actions
12
+  -lp, --list-projects        List available JIRA projects
13
+  -is, --get-issues           list issues
14
+  -i, --get-issue             show an issue
15
+  -pi, --post-issue           post and issue
16
+JIRA options
17
+  --jira-account=URL-SUBDOMAIN The jira account to use.
18
+                              Default: atomampd
19
+Filtering Issues
20
+  -s, --status=STR            Only show issues with a certain status
21
+Other options
22
+  -h, --help                  Show this help
23
+  -v, --version               Show the program version
24
+```