README: move getting started instructions to top Change-Id: I4851e02f33d99429ed6e47087dd2bddad929b7bc Reviewed-on: https://code-review.googlesource.com/15930 Reviewed-by: JBD <jbd@google.com>
diff --git a/README.md b/README.md index 9005315..c1ce979 100644 --- a/README.md +++ b/README.md
@@ -1,20 +1,50 @@ # Google APIs Client Library for Go -## Library maintenance -This client library is supported, but in maintenance mode only. -We are fixing necessary bugs and adding essential features to ensure this -library continues to meet your needs for accessing Google APIs. -Non-critical issues will be closed. -Any issue may be reopened if it is causing ongoing problems. +## Getting Started + +``` +$ go get google.golang.org/api/tasks/v1 +$ go get google.golang.org/api/moderator/v1 +$ go get google.golang.org/api/urlshortener/v1 +... etc ... +``` + +and using: + +```go +package main + +import ( + "net/http" + + "google.golang.org/api/urlshortener/v1" +) + +func main() { + svc, err := urlshortener.New(http.DefaultClient) + // ... +} +``` + +* For a longer tutorial, see the [Getting Started guide](https://github.com/google/google-api-go-client/blob/master/GettingStarted.md). +* For examples, see the [examples directory](https://github.com/google/google-api-go-client/tree/master/examples). +* For support, use the [golang-nuts](https://groups.google.com/group/golang-nuts) mailing list. ## Status [](https://travis-ci.org/google/google-api-go-client) +[](https://godoc.org/google.golang.org/api) These are auto-generated Go libraries from the Google Discovery Service's JSON description files of the available "new style" Google APIs. Due to the auto-generated nature of this collection of libraries, complete APIs or specific versions can appear or go away without notice. As a result, you should always locally vendor any API(s) that your code relies upon. +This client library is supported, but in maintenance mode only. +We are fixing necessary bugs and adding essential features to ensure this +library continues to meet your needs for accessing Google APIs. +Non-critical issues will be closed. +Any issue may be reopened if it is causing ongoing problems. + If you're working with Google Cloud Platform APIs such as Datastore or Pub/Sub, consider using the [Cloud Client Libraries for Go](https://github.com/GoogleCloudPlatform/google-cloud-go) @@ -25,37 +55,6 @@ alpha/beta, and indicated as such in the import path (e.g., "google.golang.org/api/someapi/v1alpha"). -Announcement email: - -* http://groups.google.com/group/golang-nuts/browse_thread/thread/6c7281450be9a21e - -Getting started documentation: - -* https://github.com/google/google-api-go-client/blob/master/GettingStarted.md - -In summary: - -``` -$ go get google.golang.org/api/storage/v1 -$ go get google.golang.org/api/tasks/v1 -$ go get google.golang.org/api/moderator/v1 -... etc ... -``` - -For docs, see e.g.: - -* https://godoc.org/google.golang.org/api/storage/v1 - -The package of a given import is the second-to-last component, before the version number. - -For examples, see: - -* https://github.com/google/google-api-go-client/tree/master/examples - -For support, use the golang-nuts@ mailing list: - -* https://groups.google.com/group/golang-nuts - ## Application Default Credentials Example Application Default Credentials provide a simplified way to obtain credentials