Preston_PLB
/
oauth2
forked from Mirrors/oauth2
1
0
Fork 0
Code Pull Requests Activity

README: add links for contributions 

Previously we described where to submit patches and report issues but
didn't have links to the right places, so let's fix that.

Change-Id: I49d9bf5f1570ba495454fa32f5fec4faa66f9667
Reviewed-on: https://go-review.googlesource.com/49851
Reviewed-by: Jaana Burcu Dogan <jbd@google.com>
This commit is contained in:
Kevin Burke 2017-07-18 20:29:57 -07:00
parent cce311a261
commit b53b38ad8a
1 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -11,6 +11,9 @@ oauth2 package contains a client implementation for OAuth 2.0 spec.
go get golang.org/x/oauth2 go get golang.org/x/oauth2
~~~~ ~~~~
Or you can manually git clone the repository to
`$(go env GOPATH)/src/golang.org/x/oauth2`.
See godoc for further documentation and examples. See godoc for further documentation and examples.
* [godoc.org/golang.org/x/oauth2](http://godoc.org/golang.org/x/oauth2) * [godoc.org/golang.org/x/oauth2](http://godoc.org/golang.org/x/oauth2)
@ -19,11 +22,11 @@ See godoc for further documentation and examples.
## App Engine ## App Engine
In change 96e89be (March 2015) we removed the `oauth2.Context2` type in favor In change 96e89be (March 2015), we removed the `oauth2.Context2` type in favor
of the [`context.Context`](https://golang.org/x/net/context#Context) type from of the [`context.Context`](https://golang.org/x/net/context#Context) type from
the `golang.org/x/net/context` package the `golang.org/x/net/context` package
This means its no longer possible to use the "Classic App Engine" This means it's no longer possible to use the "Classic App Engine"
`appengine.Context` type with the `oauth2` package. (You're using `appengine.Context` type with the `oauth2` package. (You're using
Classic App Engine if you import the package `"appengine"`.) Classic App Engine if you import the package `"appengine"`.)
@ -39,36 +42,36 @@ If you don't want to update your entire app to use the new App Engine packages,
you may use both sets of packages in parallel, using only the new packages you may use both sets of packages in parallel, using only the new packages
with the `oauth2` package. with the `oauth2` package.
import ( ```go
"golang.org/x/net/context" import (
"golang.org/x/oauth2" "golang.org/x/net/context"
"golang.org/x/oauth2/google" "golang.org/x/oauth2"
newappengine "google.golang.org/appengine" "golang.org/x/oauth2/google"
newurlfetch "google.golang.org/appengine/urlfetch" newappengine "google.golang.org/appengine"
newurlfetch "google.golang.org/appengine/urlfetch"
"appengine" "appengine"
) )
func handler(w http.ResponseWriter, r *http.Request) { func handler(w http.ResponseWriter, r *http.Request) {
var c appengine.Context = appengine.NewContext(r) var c appengine.Context = appengine.NewContext(r)
c.Infof("Logging a message with the old package") c.Infof("Logging a message with the old package")
var ctx context.Context = newappengine.NewContext(r) var ctx context.Context = newappengine.NewContext(r)
client := &http.Client{ client := &http.Client{
Transport: &oauth2.Transport{ Transport: &oauth2.Transport{
Source: google.AppEngineTokenSource(ctx, "scope"), Source: google.AppEngineTokenSource(ctx, "scope"),
Base: &newurlfetch.Transport{Context: ctx}, Base: &newurlfetch.Transport{Context: ctx},
}, },
}
client.Get("...")
} }
client.Get("...")
}
```
## Contributing ## Report Issues / Send Patches
We appreciate your help! This repository uses Gerrit for code changes. To learn how to submit changes to
this repository, see https://golang.org/doc/contribute.html.
To contribute, please read the contribution guidelines: The main issue tracker for the oauth2 repository is located at
https://golang.org/doc/contribute.html https://github.com/golang/oauth2/issues.
Note that the Go project does not use GitHub pull requests but
uses Gerrit for code reviews. See the contribution guide for details.