From 76e73f32524e56f29d2ce658ec1a654336d605fd Mon Sep 17 00:00:00 2001 From: Andy Grunwald Date: Thu, 3 Sep 2015 12:25:03 +0200 Subject: [PATCH] Added more information to README --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1a2eaf..4bc0ef4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ -# gojira -Go client library for Atlassian JIRA +# 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). \ No newline at end of file