Skip to content

Commit

Permalink
[google_sign_in] document web usage (flutter#3876)
Browse files Browse the repository at this point in the history
Fixes flutter/flutter#81848

Also fixed some headers in the readme and one more link

Prepare for v5.0.3 release
  • Loading branch information
kevmoo authored and fotiDim committed Sep 13, 2021
1 parent 8058193 commit a60e64b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
3 changes: 2 additions & 1 deletion packages/google_sign_in/google_sign_in/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## NEXT
## 5.0.3

* Fixed links in `README.md`.
* Added documentation for usage on the web.

## 5.0.2

Expand Down
16 changes: 11 additions & 5 deletions packages/google_sign_in/google_sign_in/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ _Note_: This plugin is still under development, and some APIs might not be
available yet. [Feedback](https://github.com/flutter/flutter/issues) and
[Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome!

## Android integration
## Platform integration

### Android integration

To access Google Sign-In, you'll need to make sure to
[register your application](https://firebase.google.com/docs/android/setup).
Expand All @@ -23,7 +25,7 @@ Make sure you've filled out all required fields in the console for
[OAuth consent screen](https://console.developers.google.com/apis/credentials/consent).
Otherwise, you may encounter `APIException` errors.

## iOS integration
### iOS integration

1. [First register your application](https://firebase.google.com/docs/ios/setup).
2. Make sure the file you download in step 1 is named
Expand Down Expand Up @@ -57,7 +59,7 @@ Otherwise, you may encounter `APIException` errors.
<!-- End of the Google Sign-in Section -->
```

### iOS additional requirement
#### iOS additional requirement

Note that according to
https://developer.apple.com/sign-in-with-apple/get-started, starting June 30,
Expand All @@ -70,12 +72,17 @@ The Flutter Favorite
[sign_in_with_apple](https://pub.dev/packages/sign_in_with_apple) plugin could
be an option.

### Web integration

For web integration details, see the
[`google_sign_in_web` package](https://pub.dev/packages/google_sign_in_web).

## Usage

### Import the package

To use this plugin, follow the
[plugin installation instructions](https://pub.dev/packages/google_sign_in#pub-pkg-tab-installing).
[plugin installation instructions](https://pub.dev/packages/google_sign_in/install).

### Use the plugin

Expand Down Expand Up @@ -114,4 +121,3 @@ Future<void> _handleSignIn() async {

Find the example wiring in the
[Google sign-in example application](https://github.com/flutter/plugins/blob/master/packages/google_sign_in/google_sign_in/example/lib/main.dart).

2 changes: 1 addition & 1 deletion packages/google_sign_in/google_sign_in/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: google_sign_in
description: Flutter plugin for Google Sign-In, a secure authentication system
for signing in with a Google account on Android and iOS.
homepage: https://github.com/flutter/plugins/tree/master/packages/google_sign_in/google_sign_in
version: 5.0.2
version: 5.0.3

flutter:
plugin:
Expand Down

0 comments on commit a60e64b

Please sign in to comment.