Skip to content

Commit

Permalink
README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
theriverman committed Jun 2, 2020
1 parent 9ad45a7 commit 34ceaf9
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,28 +129,25 @@ func main() {
HTTPClient: &http.Client{},
}

// Initialise client (authenticates to Taiga)
// Initialise client
err := client.Initialise()
if err != nil {
log.Fatalln(err)
}

// Authenticate (get/set Token)
// Authenticate (get/set the JWT)
client.AuthByCredentials(&taiga.Credentials{
Type: "normal",
Username: "my_pretty_username",
Password: "123123",
})

// Set default project (optional. it is for convenience)
client.SetDefaultProjectBySlug("theriverman-test-1337")

// Get /users/me
me, _ := client.User.Me()
fmt.Println("Me: (ID, Username, FullName)", me.ID, me.Username, me.FullName)

// Get Project [ theriverman-api-dev-testing-1337 ]
slug := "theriverman-api-dev-testing-1337"
// Get Project (by its slug)
slug := "therivermantaigo-taigo-public-test"
fmt.Printf("Getting Project (slug=%s)..\n", slug)
project, err := client.Project.GetBySlug(slug)
if err != nil {
Expand Down Expand Up @@ -186,12 +183,12 @@ newAttachment, err := client.Epic.CreateAttachment(&taiga.Attachment{ObjectID: 1
```

## Non-Standard Operations (Non-Standard)
1. Clone Epic (with UserStories)
2. Clone Epic (without UserStories)
3. Clone UserStory (with sub-tasks)
4. Clone UserStory (without sub-tasks)
5. Clone Sub-Task
6. Copy UserStory to another project [will lose comments and attachments]
1. Clone Epic (with UserStories) -- To be implemented
2. Clone Epic (without UserStories) -- To be implemented
3. Clone UserStory (with sub-tasks) -- To be implemented
4. Clone UserStory (without sub-tasks) -- To be implemented
5. Clone Sub-Task -- To be implemented
6. Copy UserStory to another project [will lose comments and attachments] -- To be implemented

## Advanced Operations
Do you need access to a non yet implemented or special API endpoint? No problem! <br>
Expand Down Expand Up @@ -233,14 +230,16 @@ if err != nil {
fmt.Println(err)
fmt.Println(resp)
} else {
fmt.Println("The following Epic Custom Attributes have been returned:")
fmt.Println("--------------------------------------------------------")
for i := 0; i < 3; i++ {
ca := epicCustomAttributes[i]
fmt.Println(" * ", ca.ID, ca.Name)
}
}
```

Such raw requests return `(*http.Response, error)`.
**Note:** Such raw requests return `(*http.Response, error)`.

# Contribution
You're contribution would be much appreciated! <br>
Expand All @@ -256,7 +255,7 @@ This package conforms to the stable HEAD philosophy.
* **develop** is *not* <i>always</i> stable

# Licenses & Recognitions
| | | |
| Product | License | Author |
|---------------------------|-----------|-----------------------------------------------------------|
| **Go Gopher** | CC3.0 | [Renee French](https://www.instagram.com/reneefrench/) |
| **Gopher Konstructor** | CC0-1.0 | [quasilyte](https://github.com/quasilyte/gopherkon) |
Expand Down

0 comments on commit 34ceaf9

Please sign in to comment.