Skip to content

Commit 565c75a

Browse files
author
Chris Moultrie
committed
New Feature, strictSSL. Preparing for publish
1 parent 9f80827 commit 565c75a

File tree

4 files changed

+93
-28
lines changed

4 files changed

+93
-28
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,18 @@ Find the status of an issue.
3838

3939
Currently there is no explicit login call necessary as each API call uses Basic Authentication to authenticate.
4040

41+
## Options ##
42+
43+
JiraApi options:
44+
* `protocol<string>`: Typically 'http:' or 'https:'
45+
* `host<string>`: The hostname for your jira server
46+
* `port<int>`: The port your jira server is listening on (probably `80` or `443`)
47+
* `user<string>`: The username to log in with
48+
* `password<string>`: Keep it secret, keep it safe
49+
* `Jira API Version<string>`: Known to work with `2` and `2.0.alpha1`
50+
* `verbose<bool>`: Log some info to the console, usually for debugging
51+
* `strictSSL<bool>`: Set to false if you have self-signed certs or something non-trustworthy
52+
4153
## Implemented APIs ##
4254

4355
* Authentication
@@ -76,6 +88,7 @@ Currently there is no explicit login call necessary as each API call uses Basic
7688
## Changelog ##
7789

7890

91+
* _0.5.0 Last param is now for strict SSL checking, defaults to true_
7992
* _0.4.1 Now handing errors in the request callback (thanks [mrbrookman](https://github.com/mrbrookman))_
8093
* _0.4.0 Now auto-redirecting between http and https (for both GET and POST)_
8194
* _0.3.1 [Request](https://github.com/mikeal/request) is broken, setting max request package at 2.15.0_

0 commit comments

Comments
 (0)