Add note about constructor options

actions · Sep 5, 2019 · 1c4866f · 1c4866f
1 parent ebace7e
commit 1c4866f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/github/README.md b/packages/github/README.md
@@ -27,6 +27,8 @@ const { data: pullRequest } = await octokit.pulls.get({
 console.log(pullRequest);
 ```
 
+You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor.
+
 You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API.
 
 ```js