Skip to content

Commit 9f23369

Browse files
committed
docs: update README examples to use v2 module path
- Updated all import statements to use github.com/jferrl/go-githubauth/v2 - Updated installation command to use v2 - Updated godoc badge URL to point to v2 documentation - Added v2 import to migration guide example
1 parent 79f09c6 commit 9f23369

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# go-githubauth
22

3-
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/jferrl/go-githubauth)
3+
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/jferrl/go-githubauth/v2)
44
[![Test Status](https://github.com/jferrl/go-githubauth/workflows/tests/badge.svg)](https://github.com/jferrl/go-githubauth/actions?query=workflow%3Atests)
55
[![codecov](https://codecov.io/gh/jferrl/go-githubauth/branch/main/graph/badge.svg?token=68I4BZF235)](https://codecov.io/gh/jferrl/go-githubauth)
66
[![Go Report Card](https://goreportcard.com/badge/github.com/jferrl/go-githubauth)](https://goreportcard.com/report/github.com/jferrl/go-githubauth)
@@ -36,7 +36,7 @@
3636
To use `go-githubauth` in your project, you need to have Go installed. You can get the package via:
3737

3838
```bash
39-
go get -u github.com/jferrl/go-githubauth
39+
go get -u github.com/jferrl/go-githubauth/v2
4040
```
4141

4242
## Usage
@@ -55,7 +55,7 @@ import (
5555
"strconv"
5656

5757
"github.com/google/go-github/v73/github"
58-
"github.com/jferrl/go-githubauth"
58+
"github.com/jferrl/go-githubauth/v2"
5959
"golang.org/x/oauth2"
6060
)
6161

@@ -99,7 +99,7 @@ import (
9999
"strconv"
100100

101101
"github.com/google/go-github/v73/github"
102-
"github.com/jferrl/go-githubauth"
102+
"github.com/jferrl/go-githubauth/v2"
103103
"golang.org/x/oauth2"
104104
)
105105

@@ -144,7 +144,7 @@ import (
144144
"os"
145145
"time"
146146

147-
"github.com/jferrl/go-githubauth"
147+
"github.com/jferrl/go-githubauth/v2"
148148
)
149149

150150
func main() {
@@ -183,7 +183,7 @@ import (
183183
"strconv"
184184
"time"
185185

186-
"github.com/jferrl/go-githubauth"
186+
"github.com/jferrl/go-githubauth/v2"
187187
)
188188

189189
func main() {
@@ -223,7 +223,7 @@ import (
223223
"os"
224224
"strconv"
225225

226-
"github.com/jferrl/go-githubauth"
226+
"github.com/jferrl/go-githubauth/v2"
227227
)
228228

229229
func main() {
@@ -277,6 +277,8 @@ tokenSource1, err := githubauth.NewApplicationTokenSource(12345, privateKey)
277277
#### After (v2.0.0)
278278

279279
```go
280+
import "github.com/jferrl/go-githubauth/v2"
281+
280282
// Using App ID - explicit int64 cast needed for type inference
281283
tokenSource1, err := githubauth.NewApplicationTokenSource(int64(12345), privateKey)
282284

0 commit comments

Comments
 (0)