Skip to content

Commit

Permalink
README.md: add notes for the v2 to v3 switch (#285)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericchiang authored Jan 7, 2021
1 parent 3bc5a7e commit c6756c8
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# go-oidc

[![GoDoc](https://godoc.org/github.com/coreos/go-oidc?status.svg)](https://pkg.go.dev/github.com/coreos/go-oidc/v3/oidc)
[![Go Reference](https://pkg.go.dev/badge/github.com/coreos/go-oidc/v3/oidc.svg)](https://pkg.go.dev/github.com/coreos/go-oidc/v3/oidc)
![github.com/coreos/go-oidc/v3](https://github.com/coreos/go-oidc/workflows/test/badge.svg?branch=v3)

## Updates from v2 to v3

There were two breaking changes made to the v3 branch. The import path has changed from:

```
github.com/coreos/go-oidc
```

to:

```
github.com/coreos/go-oidc/v3/oidc
```

And the return type of `NewRemoteKeySet()` is now `*RemoteKeySet` instead of an interface ([#262](https://github.com/coreos/go-oidc/pull/262)).

## OpenID Connect support for Go

This package enables OpenID Connect support for the [golang.org/x/oauth2](https://godoc.org/golang.org/x/oauth2) package.
Expand Down

0 comments on commit c6756c8

Please sign in to comment.