Add `README.md`

main
Jasper Bok 2023-07-17 21:16:28 +02:00
parent 4391253397
commit dbe986d2cb
1 changed files with 38 additions and 0 deletions

38
README.md 100644
View File

@ -0,0 +1,38 @@
# Jira Client
A small and very incomplete Jira client library.
## Installation
```shell
go get git.jasperbok.nl/jasperbok/jiraclient.git
```
## Usage
```go
package main
import (
"fmt"
"log"
"git.jasperbok.nl/jasperbok/jiraclient.git"
)
jira := jiraclient.NewJiraClient("username", "token", "atlassian.net_subdomain")
issue, err := jira.GetIssue("ABC-12")
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s\n", issue.Summary)
```
## API
### `NewJiraClient(string, string, string) JiraClient`
### `JiraClient.GetIssue(string) (Issue, error)`
### `JiraClient.GetProject(string) (Project, error)`
### `JiraClient.Search(string) ([]Issue, error)`