Merge pull request #435 from FormidableLabs/chore/github-auth-example

Add a config example for GitHub

Author: Kadi Kraman

README.md

@@ -41,6 +41,7 @@ These providers implement the OAuth2 spec, but are not OpenID providers, which m
 * [Dropbox](https://www.dropbox.com/developers/reference/oauth-guide) ([Example configuration](./docs/config-examples/dropbox.md))
 * [Reddit](https://github.com/reddit-archive/reddit/wiki/oauth2) ([Example configuration](./docs/config-examples/reddit.md))
 * [Coinbase](https://developers.coinbase.com/docs/wallet/coinbase-connect/integrating) ([Example configuration](./docs/config-examples/coinbase.md))
+* [GitHub](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/) ([Example configuration](./docs/config-examples/github.md))
 
 ## Why you may want to use this library
 

docs/config-examples/github.md

@@ -0,0 +1,27 @@
+# GitHub
+
+** This is Android Only **
+
+Read more about iOS restrictions [here](https://github.com/FormidableLabs/react-native-app-auth/issues/194).
+
+Go to [OAuth Apps](https://github.com/settings/developers) to create your app.
+
+For the Authorization callback URL, choose something like `com.myapp://oauthredirect` and ensure you use `com.myapp` in your `appAuthRedirectScheme` in `android/app/build.gradle`.
+
+```js
+const config = {
+  redirectUrl: 'com.my.auth.app://oauthredirect',
+  clientId: '<client-id>',
+  clientSecret: '<client-seret',
+  scopes: ['identity'],
+  serviceConfiguration: {
+    authorizationEndpoint: 'https://github.com/login/oauth/authorize',
+    tokenEndpoint: 'https://github.com/login/oauth/access_token',
+    revocationEndpoint:
+      'https://github.com/settings/connections/applications/<client-id>'
+  }
+};
+
+// Log in to get an authentication token
+const authState = await authorize(config);
+```