doc.go - include versioned import path (#1098)

google · Jan 16, 2019 · e740a68 · e740a68
1 parent 2205ffa
commit e740a68
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/github/doc.go b/github/doc.go
@@ -8,7 +8,8 @@ Package github provides a client for using the GitHub API.
 
 Usage:
 
-	import "github.com/google/go-github/github"
+	import "github.com/google/go-github/v21/github"	// with go modules enabled (GO111MODULE=on or outside GOPATH)
+	import "github.com/google/go-github/github"     // with go modules disabled
 
 Construct a new GitHub client, then use the various services on the client to
 access different parts of the GitHub API. For example: