Skip to content

Commit

Permalink
Merge pull request gskinnerTeam#3 from gskinnerTeam/updated-readme
Browse files Browse the repository at this point in the history 
Updated readme
  • Loading branch information
@trevordunn
trevordunn authored Jul 8, 2020
2 parents b7f11cf + e9ec2ba commit 56c960a
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ A fresh and modern Google Contacts manager that integrates with GitHub and Twitt

### 2. Add Required API Keys

Google Sign In is required in order to run the app (unless running with [cached data](#running-with-cached-data)). You will need to provide your own Google API keys in the `/lib/api_keys.dart` file. Follow the instructions here to create them:
- https://developers.google.com/people/v1/how-tos/authorizing#APIKey
Google Sign In is required in order to run the app (unless running with [cached data](#running-with-cached-data)). The app uses the Google People API, and you will need to provide your own Google OAuth 2 client credentials in the `/lib/api_keys.dart` file.

Follow the instructions here to enable the People API and create credentials:
- https://developers.google.com/people/v1/getting-started
- https://developers.google.com/people/v1/how-tos/authorizing
In your Google API Console, ensure you add the People API scope, "https://www.googleapis.com/auth/contacts". Please see below for details:
- https://developers.google.com/identity/protocols/oauth2/scopes#people

To optionally fetch social data for your contacts, add your own API keys for those as well:
- Twitter: https://developer.twitter.com/en/docs/basics/getting-started
Expand Down

0 comments on commit 56c960a

Please sign in to comment.