Skip to content

Commit d92a009

Browse files
authored
docs: small updates (#64)
1 parent ed01ddf commit d92a009

File tree

3 files changed

+43
-30
lines changed

3 files changed

+43
-30
lines changed

docs/install.mdx

+9-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_position: 1
44

55
# Installation
66

7-
There are two ways to consume the package: [premium](https://universal-sign-in.com) and free.
7+
There are two ways to consume the package: [paid](https://universal-sign-in.com) and free.
8+
9+
Why paid? According to the [State of React Native Survey](https://results.2024.stateofreactnative.com/en-US/opinions/#opinions_pain_points_multiple), unmaintained packages are **the #1 pain point** of the React Native ecosystem. Your purchase enables the module reliability, and contributions to upstream SDKs such as [1](https://github.com/openid/AppAuth-iOS/pull/788), [2](https://github.com/google/GoogleSignIn-iOS/pull/402), [3](https://github.com/googlesamples/google-services/issues/426).
810

911
[//]: # '🌟'
1012

@@ -19,7 +21,7 @@ There are two ways to consume the package: [premium](https://universal-sign-in.c
1921
- iOS & macOS: Powered by the [Google Sign-In SDK](https://developers.google.com/identity/sign-in/ios/start)
2022

2123
- **Licensed:** see [pricing](https://universal-sign-in.com/#pricing) and [license](https://universal-sign-in.com/license).
22-
- **Trusted**: A total of over 160k npm package downloads.
24+
- **Trusted**: A total of over 170k npm package downloads.
2325
- **Faster Sign-Ups**: Reduce sign-up and sign-in times on Android by up to 50%, according to [Google](https://developer.android.com/identity/sign-in/legacy-gsi-migration#authentication).
2426
- **See the UI**: [screenshots](screenshots) of the features.
2527

@@ -29,23 +31,23 @@ There are two ways to consume the package: [premium](https://universal-sign-in.c
2931

3032
[//]: # '🖥️ **Unified API** - Write code once, deploy everywhere.'
3133

32-
📱 **An example app** - to showcase all Universal sign in features
33-
34-
_Your purchase enables improvements in the module and upstream SDKs (such as [1](https://github.com/openid/AppAuth-iOS/pull/788), [2](https://github.com/google/GoogleSignIn-iOS/pull/402), [3](https://github.com/googlesamples/google-services/issues/426))._
34+
📱 **An example app** - to showcase all features on native and web
3535

3636
### Public version (free)
3737

3838
Available on the public npm registry under MIT license, this version:
3939

40-
- Uses the functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating) which will be removed from the Google Play Services Auth SDK (`com.google.android.gms:play-services-auth`) later in 2025. The free version will continue to use a version where the deprecated SDK is present.
40+
- Uses the functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating) which will be removed from the Google Play Services Auth SDK (`com.google.android.gms:play-services-auth`) later in 2025. The free package will continue to use a version where the deprecated SDK is present.
4141
- Has platform support limited to Android and iOS.
4242
- Contains none of the extra features listed above.
4343

4444
> If you want to migrate from the public version to the Universal version, follow the [migration guide](migrating#migrating-from-original-to-universal-sign-in).
4545
4646
## Obtaining Universal Sign In {#obtaining-access}
4747

48-
Universal sign in requires [purchasing a license](https://universal-sign-in.com/#pricing), after which you will be able to configure your (or your colleagues') access to the private npm package and to the private repo with the sources and examples. Alternatively, as an Expo customer, obtain access through this [form](https://forms.gle/tpP7TfUGW1CwgaEZ8).
48+
Universal sign in requires [purchasing a license](https://universal-sign-in.com/#pricing), after which you will be able to configure your (or your colleagues') access to the private npm package and to the private repo with the sources and examples.
49+
50+
> Are you an EAS customer? You may be able to access the premium version for free, [learn more](https://forms.gle/tpP7TfUGW1CwgaEZ8).
4951
5052
[//]: # 'Note that this version is distributed under a [custom license](license).'
5153

docs/license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ sidebar_position: 80
66

77
The Original module is licensed as MIT, the Universal sign in module has [this license](https://universal-sign-in.com/license).
88

9-
Please do get in touch if you have any questions or concerns about the license!
9+
Please [get in touch](mailto:[email protected]) if you have any questions or concerns about the license!

docs/setting-up/get-config-file.mdx

+33-22
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
sidebar_position: 15
3+
sidebar_label: Configuration
34
---
45

56
# Obtaining configuration information
@@ -29,35 +30,43 @@ import Tabs from '@theme/Tabs';
2930
import TabItem from '@theme/TabItem';
3031

3132
<Tabs>
32-
<TabItem value="eas" label="When using Expo EAS">
33-
If you use [Expo EAS](https://expo.dev/eas), run `eas credentials` to obtain the Keystore information, which includes the SHA-1 fingerprint. See [EAS credentials docs](https://docs.expo.dev/app-signing/managed-credentials/#inspecting-credentials-configuration) to learn more.
34-
</TabItem>
35-
<TabItem value="local" label="When developing locally">
36-
1. From your project root, `cd android && ./gradlew signingReport`.
37-
2. Scroll to the top of output, see the fingerprints. Debug fingerprint is used for debug apk,
38-
release fingerprint is used for release APK.
39-
</TabItem>
40-
4133
<TabItem value="playStore" label="When releasing via Google Play Store">
42-
Check if "Google Play App Signing" is enabled for your app [in the console](https://play.google.com/console/u/0/).
34+
Check if "Google Play App Signing" is enabled for your app [in the console](https://play.google.com/console/).
4335
If it is enabled, you need to take the following steps:
4436

45-
1. In Google Play Console, navigate to: \<Your App\> -> Release section (in the left sidebar) -> Setup -> App Signing.
46-
2. Under the "App signing key certificate" _and also_ "Upload key certificate", take note of `SHA-1 certificate fingerprint`. That's a total of two or more fingerprints (Play Store sometimes has more than one "App signing key certificate"!).
37+
1. In Google Play Console, navigate to: \<Your App\> -> Release section (in the left sidebar) -> Setup -> App Signing.
38+
2. Under the "App signing key certificate" _and also_ "Upload key certificate", take note of `SHA-1 certificate fingerprint`. That's a total of two or more fingerprints (Play Store sometimes has more than one "App signing key certificate"!).
4739

4840
</TabItem>
41+
42+
<TabItem value="eas" label="When using Expo EAS">
43+
If you use [Expo EAS](https://expo.dev/eas), run `eas credentials` to obtain
44+
the Keystore information, which includes the SHA-1 fingerprint. See [EAS
45+
credentials
46+
docs](https://docs.expo.dev/app-signing/managed-credentials/#inspecting-credentials-configuration)
47+
to learn more.
48+
</TabItem>
49+
50+
<TabItem value="local" label="When developing locally">
51+
1. From your project root, `cd android && ./gradlew signingReport`.
52+
2. Scroll to the top of output, see the fingerprints. Debug fingerprint is used for debug apk,
53+
release fingerprint is used for release APK.
54+
</TabItem>
4955
</Tabs>
5056

57+
<br />
58+
<br />
59+
5160
### Step 2: Add SHA-1 hashes to Firebase or Google Cloud Console {#step-2}
5261

5362
Using _all_ of the SHA-1 fingerprints obtained in the previous step, follow the instructions below.
5463

5564
<Tabs queryString="firebase-or-not">
5665
<TabItem value="firebase" label="When using Firebase">
57-
1. Sign in to Firebase and open your project.
66+
1. Sign in to [Firebase Console](https://console.firebase.google.com/) and open your project.
5867
2. Ensure that in the "Authentication" menu, "Google" is enabled as "Sign-in method".
59-
3. Click the Settings icon and select Project settings.
60-
4. In the "Your apps" card, select the app you need to add SHA-1 to.
68+
3. Click the settings icon and go to "Project settings".
69+
4. Scroll down to "Your apps" section, and select the app.
6170
5. Click "Add fingerprint".
6271
6. Check that "Package name" is correct.
6372
7. Download the `google-services.json` file.
@@ -67,8 +76,9 @@ Using _all_ of the SHA-1 fingerprints obtained in the previous step, follow the
6776
</TabItem>
6877

6978
<TabItem value="cloud-console" label="When not using Firebase">
70-
Follow the "Create authorization credentials" instructions
71-
[here](https://developers.google.com/identity/protocols/oauth2/native-app#android) to create an "OAuth client ID" of type Android for each of the SHA-1 fingerprints you obtained - see the screenshot below.
79+
Create an OAuth Client ID of type Android in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_) for each of the SHA-1 fingerprints you obtained - see the screenshot below.
80+
81+
Alternatively, use <a href="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D" target="_blank">this wizard</a>.
7282

7383
You will _NOT_ need the created IDs later - the only goal here is for them to be created in the Google Cloud Console.
7484

@@ -88,18 +98,19 @@ Read below on how to set up Google Sign In for your iOS app.
8898
<TabItem value="firebase" label="When using Firebase">
8999

90100
1. Sign in to [Firebase Console](https://console.firebase.google.com/) and open your project.
91-
2. Click the settings icon and go to "Project settings".
92-
3. Scroll down to "Your apps" section, and select the app.
93-
4. Check that "Bundle ID" is correct.
94-
5. Download the `GoogleService-Info.plist` file.
101+
2. Ensure that in the "Authentication" menu, "Google" is enabled as "Sign-in method".
102+
3. Click the settings icon and go to "Project settings".
103+
4. Scroll down to "Your apps" section, and select the app.
104+
5. Check that "Bundle ID" is correct.
105+
6. Download the `GoogleService-Info.plist` file.
95106

96107
</TabItem>
97108

98109
<TabItem value="cloud-console" label="When not using Firebase">
99110

100111
Remember that _all_ created client IDs can be found in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_).
101112

102-
Obtain the "iOS OAuth Client ID" _and_ "iOS URL scheme" (also known as `reversed client id`): Create or use an existing OAuth Client ID of type iOS in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_). Alternatively, use <a href="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D" target="_blank">this wizard</a>.
113+
Obtain the "iOS OAuth Client ID" _and_ "iOS URL scheme" (also known as `reversed client id`): Create an OAuth Client ID of type iOS in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_). Alternatively, use <a href="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D" target="_blank">this wizard</a>.
103114

104115
You will need the iOS Client ID and iOS URL scheme later.
105116

0 commit comments

Comments
 (0)