2015-09-03 12:25:03 +02:00
|
|
|
# go-jira
|
|
|
|
|
|
|
|
[![GoDoc](https://godoc.org/github.com/andygrunwald/go-jira?status.svg)](https://godoc.org/github.com/andygrunwald/go-jira)
|
|
|
|
[![Build Status](https://travis-ci.org/andygrunwald/go-jira.svg?branch=master)](https://travis-ci.org/andygrunwald/go-jira)
|
|
|
|
[![Coverage Status](https://coveralls.io/repos/andygrunwald/go-jira/badge.svg?branch=master&service=github)](https://coveralls.io/github/andygrunwald/go-jira?branch=master)
|
|
|
|
|
|
|
|
Go client library for [Atlassian JIRA](https://www.atlassian.com/software/jira).
|
|
|
|
|
|
|
|
TODO: Add JIRA logo + Gopher
|
|
|
|
|
|
|
|
The code structure of this package was inspired by [google/go-github](https://github.com/google/go-github).
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
TODO: Provide a list of features
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
It is go gettable
|
|
|
|
|
|
|
|
$ go get github.com/andygrunwald/go-jira
|
|
|
|
|
|
|
|
(optional) to run unit / example tests:
|
|
|
|
|
|
|
|
$ cd $GOPATH/src/github.com/andygrunwald/go-jira
|
|
|
|
$ go test -v
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
|
Please have a look at the [GoDoc documentation](https://godoc.org/github.com/andygrunwald/go-jira) for a detailed API description.
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
Further a few examples how the API can be used.
|
|
|
|
A few more examples are available in the [GoDoc examples section](https://godoc.org/github.com/andygrunwald/go-jira#pkg-examples).
|
|
|
|
|
|
|
|
TODO: Provide examples
|
|
|
|
|
|
|
|
## Implementations
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
This project is released under the terms of the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
|