Skip to content

Commit 7d525b0

Browse files
authored
Update README.md for changes introduced in #269 (#390)
* Update README.md * Update README.md * Update README.md
1 parent e808d9e commit 7d525b0

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Capacitor plugin for Google Auth.
99
<a href="https://www.npmjs.com/package/@codetrix-studio/capacitor-google-auth"><img alt="npm" src="https://img.shields.io/npm/v/@codetrix-studio/capacitor-google-auth"></a> <a href="https://www.npmjs.com/package/@codetrix-studio/capacitor-google-auth"><img alt="npm" src="https://img.shields.io/npm/dt/@codetrix-studio/capacitor-google-auth"></a> <a href="https://www.npmjs.com/package/@codetrix-studio/capacitor-google-auth"><img alt="npm" src="https://img.shields.io/npm/dw/@codetrix-studio/capacitor-google-auth"></a> <a href="https://libraries.io/npm/@codetrix-studio%2Fcapacitor-google-auth"><img alt="Dependents (via libraries.io)" src="https://img.shields.io/librariesio/dependents/npm/@codetrix-studio/capacitor-google-auth"></a> <a href="https://packagephobia.com/result?p=@codetrix-studio/capacitor-google-auth"><img alt="install size" src="https://packagephobia.com/badge?p=@codetrix-studio/capacitor-google-auth"></a>
1010
</p>
1111

12+
## Breaking change in V6
13+
14+
In the v6 version, `clientId` in the initialize method is used in priority over other places you could set up. If before you were using this only on the web, unset it on mobile. Or set it conditionally to replicate old behavior.
15+
1216
## Contributions
1317

1418
PRs are welcome and much appreciated that keeps this plugin up to date with Capacitor and official Google Auth platform library feature parity.
@@ -143,26 +147,19 @@ or see more [CapacitorGoogleAuth-Vue3-example](https://github.com/reslear/Capaci
143147
2. Add **identifier** `REVERSED_CLIENT_ID` as **URL schemes** to `Info.plist` from **iOS URL scheme**<br>
144148
(Xcode: App - Targets/App - Info - URL Types, click plus icon)
145149

146-
3. Set **Client ID** one of the ways:
147-
1. Set in `capacitor.config.json`
148-
- `iosClientId` - specific key for iOS
149-
- `clientId` - or common key for Android and iOS
150-
2. Download `GoogleService-Info.plist` file with `CLIENT_ID` and copy to **ios/App/App** necessarily through Xcode for indexing.
151-
152-
plugin first use `iosClientId` if not found use `clientId` if not found use value `CLIENT_ID` from file `GoogleService-Info.plist`
150+
3. Set **Client ID** one of the ways (by order of importance in the plugin):
151+
1. Set `clientId` in initialize method
152+
2. Set `iosClientId` in `capacitor.config.json`
153+
3. Set `clientId` in `capacitor.config.json`
154+
4. Set `CLIENT_ID` in `GoogleService-Info.plist`
153155

154156
### Android
155157

156-
Set **Client ID** :
157-
158-
1. In `capacitor.config.json`
159-
160-
- `androidClientId` - specific key for Android
161-
- `clientId` - or common key for Android and iOS
162-
163-
2. or set inside your `strings.xml`
164-
165-
plugin first use `androidClientId` if not found use `clientId` if not found use value `server_client_id` from file `strings.xml`
158+
Set **Client ID** (by order of importance in the plugin):
159+
1. Set `clientId` in initialize method
160+
2. Set `androidClientId` in `capacitor.config.json`
161+
3. Set `clientId` in `capacitor.config.json`
162+
4. Set `server_client_id` in `strings.xml`
166163

167164
```xml
168165
<resources>

0 commit comments

Comments
 (0)