Skip to content

Commit

Permalink
chore: minor docs polish (#59)
Browse files Browse the repository at this point in the history
* chore: minor docs polish

* chore: minor docs polish
  • Loading branch information
vonovak authored Mar 2, 2025
1 parent eda0559 commit 698e4df
Show file tree
Hide file tree
Showing 13 changed files with 1,025 additions and 965 deletions.
893 changes: 0 additions & 893 deletions .yarn/releases/yarn-4.1.1.cjs

This file was deleted.

935 changes: 935 additions & 0 deletions .yarn/releases/yarn-4.7.0.cjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-4.1.1.cjs
yarnPath: .yarn/releases/yarn-4.7.0.cjs
16 changes: 8 additions & 8 deletions docs/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ There are two ways to consume the package:

[//]: # '🌟'

### Universal Sign In {#sponsor-only-version}
### Universal Sign In ([premium](https://universal-sign-in.com)) {#sponsor-only-version}

⭐️ **Key Features**:

- **Cross-Platform**: Unified API which works on **Android**, **iOS**, **Web**, and **macOS**.
- **Cross-Platform**: Unified APIs which work on **Android**, **iOS**, **Web**, and **macOS**.

- Android: Built with [Credential Manager library](https://developers.google.com/identity/android-credential-manager)
- Web: Uses [Sign In with Google for Web](https://developers.google.com/identity/gsi/web/guides/features)
- iOS & macOS: Powered by the [Google Sign-In SDK](https://developers.google.com/identity/sign-in/ios/start)

- **Licensed:** see [pricing](https://universal-sign-in.com/#pricing) and [license](https://universal-sign-in.com/license).
- **Trusted**: Over 130k npm package downloads.
- **See the UI**: [screenshots](screenshots) of the features.
- **Trusted**: A total of over 150k npm package downloads.
- **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).
- **See the UI**: [screenshots](screenshots) of the features.

🛡️ **Advanced [security features](/docs/security)**

Expand All @@ -31,14 +31,14 @@ There are two ways to consume the package:

📱 **An example app** - to showcase all Universal sign in features

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)).
_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))._

### Public version
### Public version (free)

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

- Uses the fully functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating).
- Has platform support limited to Android and iOS.
- Uses functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating).
- Contains none of the extra features listed above.

> 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).
Expand Down
2 changes: 1 addition & 1 deletion docs/integration-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 51
sidebar_position: 55
---

# Integration notes
Expand Down
17 changes: 0 additions & 17 deletions docs/jest-mock.md

This file was deleted.

5 changes: 3 additions & 2 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
sidebar_position: 80
sidebar_label: License
---

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

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

Please do get in touch if you have any questions or concerns about the license!
2 changes: 1 addition & 1 deletion docs/screenshots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 78
sidebar_label: Screenshots
---

# Universal Sign In Screenshots
# Universal sign in screenshots

:::tip
Universal Sign In is only available in the licensed version. [You can get a license here](https://universal-sign-in.com/#pricing) ⭐️.
Expand Down
10 changes: 10 additions & 0 deletions docs/setting-up/get-config-file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,13 @@ Read below on how to set up Google Sign In for your iOS app.
[//]: # '(offline support, web support)'

For some use cases, a Web Client ID is needed (provided to the `configure()` call). To obtain a Web Client ID, go to [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_) and find an existing one (it may have been already created by Firebase) or create a new OAuth Client ID of type **Web**.

---

## Summary

At the end of this guide, regardless of whether you use Firebase, when you visit [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_), you should have in the "OAuth 2.0 Client IDs" section:

- Android OAuth Client ID(s) with SHA-1 fingerprints
- iOS OAuth Client ID(s) with iOS URL scheme
- Web Client ID
25 changes: 25 additions & 0 deletions docs/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 50
---

# Testing

## Setting up a mock

If you use Jest for testing, you may need to mock the functionality of the native module - this is because the native code cannot run in Node environment.

This library ships with a Jest mock that you can add to the `setupFiles` array in your Jest config.

By default, the mock behaves as if the calls were successful and returns mock user data.

```json title="jest.config.js|ts|mjs|cjs|json"
{
"setupFiles": [
"./node_modules/@react-native-google-signin/google-signin/jest/build/jest/setup.js"
]
}
```

[//]: # '### Writing tests'
[//]: #
[//]: # 'You can use [`@testing-library/react-native`](https://callstack.github.io/react-native-testing-library/) to write tests for React components that use React Native Google Sign In.'
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@
"@mdx-js/react": "^3.1.0",
"clsx": "^2.1.1",
"docusaurus-lunr-search": "^3.6.1",
"prism-react-renderer": "^2.4.0",
"prism-react-renderer": "^2.4.1",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.6.3",
"@docusaurus/tsconfig": "^3.6.3",
"@docusaurus/types": "^3.6.3",
"docusaurus-plugin-typedoc": "^1.0.5",
"docusaurus-plugin-typedoc": "^1.2.3",
"prettier": "^3.3.3",
"typedoc": "^0.27.6",
"typedoc-plugin-markdown": "^4.4.1",
"typescript": "~5.6.3"
"typedoc": "^0.27.9",
"typedoc-plugin-markdown": "^4.4.2",
"typescript": "~5.8.2"
},
"browserslist": {
"production": [
Expand All @@ -52,5 +52,5 @@
"engines": {
"node": ">=18.0"
},
"packageManager": "yarn@4.1.1"
"packageManager": "yarn@4.7.0"
}
9 changes: 4 additions & 5 deletions src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
description: (
<>
Supports Android, iOS, Web and MacOS. <br /> Also works with Expo
(requires development client)!
Supports Android, iOS, Web and MacOS. <br /> Also works with Expo!
</>
),
},
Expand All @@ -25,7 +24,7 @@ const FeatureList: FeatureItem[] = [
description: (
<>
Thanks to the licensed version, the module is maintained, and comes with
this detailed documentation site.
detailed documentation.
</>
),
},
Expand All @@ -35,8 +34,8 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
description: (
<>
Supports the New Architecture (including bridgeless mode), and most of
the features of the native SDKs. Open an issue if something's missing!
Supports the New Architecture, and most of the features of the native
SDKs. Open an issue if something's missing!
</>
),
},
Expand Down
62 changes: 31 additions & 31 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7480,14 +7480,14 @@ __metadata:
"@mdx-js/react": "npm:^3.1.0"
clsx: "npm:^2.1.1"
docusaurus-lunr-search: "npm:^3.6.1"
docusaurus-plugin-typedoc: "npm:^1.0.5"
docusaurus-plugin-typedoc: "npm:^1.2.3"
prettier: "npm:^3.3.3"
prism-react-renderer: "npm:^2.4.0"
prism-react-renderer: "npm:^2.4.1"
react: "npm:^18.3.1"
react-dom: "npm:^18.3.1"
typedoc: "npm:^0.27.6"
typedoc-plugin-markdown: "npm:^4.4.1"
typescript: "npm:~5.6.3"
typedoc: "npm:^0.27.9"
typedoc-plugin-markdown: "npm:^4.4.2"
typescript: "npm:~5.8.2"
languageName: unknown
linkType: soft

Expand Down Expand Up @@ -7517,12 +7517,12 @@ __metadata:
languageName: node
linkType: hard

"docusaurus-plugin-typedoc@npm:^1.0.5":
version: 1.0.5
resolution: "docusaurus-plugin-typedoc@npm:1.0.5"
"docusaurus-plugin-typedoc@npm:^1.2.3":
version: 1.2.3
resolution: "docusaurus-plugin-typedoc@npm:1.2.3"
peerDependencies:
typedoc-plugin-markdown: ">=4.0.0"
checksum: 10c0/fff201b77862be882a9ac8d1d5e6115fbb3287a94d90999cbb4a3062266bf39c207b47735effb6952fc94dd29261d39b89e36bf39e114d031013903971007df3
typedoc-plugin-markdown: ">=4.4.0"
checksum: 10c0/38e490033a65ffaa4f38f84b45a2f76590f953ee151523b2b1ce4d8b84c9b5c26f58da59714f9effda521eb8e3ed33eb2d91c7003929d6ce3efc53479e0c0764
languageName: node
linkType: hard

Expand Down Expand Up @@ -12829,15 +12829,15 @@ __metadata:
languageName: node
linkType: hard

"prism-react-renderer@npm:^2.4.0":
version: 2.4.0
resolution: "prism-react-renderer@npm:2.4.0"
"prism-react-renderer@npm:^2.4.1":
version: 2.4.1
resolution: "prism-react-renderer@npm:2.4.1"
dependencies:
"@types/prismjs": "npm:^1.26.0"
clsx: "npm:^2.0.0"
peerDependencies:
react: ">=16.0.0"
checksum: 10c0/3d6969b057da0efe39e3e637bf93601cd5757de5919180e8df16daf1d1b8eedc39b70c7f6f28724fba0a01bc857c6b78312ab027f4e913159d1165c5aba235bb
checksum: 10c0/ebbe8feb975224344bbdd046b3a937d121592dbe4b8f22ba0be31f5af37b9a8219f441138ef6cab1c5b96f2aa6b529015200959f7e5e85b60ca69c81d35edcd4
languageName: node
linkType: hard

Expand Down Expand Up @@ -14783,49 +14783,49 @@ __metadata:
languageName: node
linkType: hard

"typedoc-plugin-markdown@npm:^4.4.1":
version: 4.4.1
resolution: "typedoc-plugin-markdown@npm:4.4.1"
"typedoc-plugin-markdown@npm:^4.4.2":
version: 4.4.2
resolution: "typedoc-plugin-markdown@npm:4.4.2"
peerDependencies:
typedoc: 0.27.x
checksum: 10c0/54c9a25aed64d07258033c4d060acac15a618ee0494cbb2bc70fd10d03c82b3434715b6db01fbeb09d672cff736340666d70da1be83188e3a994048a0a0c6b65
checksum: 10c0/93112f0f06f1c0bc7eec1ba7f9034b88a6817a92ec41e491e8ac73c23a5fbda84df537d136395295737499fc1d5afa94d1500a1921b1a967248dc5d3054fc9d6
languageName: node
linkType: hard

"typedoc@npm:^0.27.6":
version: 0.27.6
resolution: "typedoc@npm:0.27.6"
"typedoc@npm:^0.27.9":
version: 0.27.9
resolution: "typedoc@npm:0.27.9"
dependencies:
"@gerrit0/mini-shiki": "npm:^1.24.0"
lunr: "npm:^2.3.9"
markdown-it: "npm:^14.1.0"
minimatch: "npm:^9.0.5"
yaml: "npm:^2.6.1"
peerDependencies:
typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x
typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x
bin:
typedoc: bin/typedoc
checksum: 10c0/74af856fc2b9ca151567db8e08737a6ab8b29efb611414510eb833f80723245bc6ade00f2be7a410e335833cfd5e3deb1ae1ecfdb4da3a13c65faedd1f1805b0
checksum: 10c0/999668d9d23e1824b762e2c411e2c0860d0ce4a2e61f23a2c31d36a1d6337a763553bc75205aee25ce34659e9315315c720694e9eccd7e7e4755873fdfec1192
languageName: node
linkType: hard

"typescript@npm:~5.6.3":
version: 5.6.3
resolution: "typescript@npm:5.6.3"
"typescript@npm:~5.8.2":
version: 5.8.2
resolution: "typescript@npm:5.8.2"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 10c0/44f61d3fb15c35359bc60399cb8127c30bae554cd555b8e2b46d68fa79d680354b83320ad419ff1b81a0bdf324197b29affe6cc28988cd6a74d4ac60c94f9799
checksum: 10c0/5c4f6fbf1c6389b6928fe7b8fcd5dc73bb2d58cd4e3883f1d774ed5bd83b151cbac6b7ecf11723de56d4676daeba8713894b1e9af56174f2f9780ae7848ec3c6
languageName: node
linkType: hard

"typescript@patch:typescript@npm%3A~5.6.3#optional!builtin<compat/typescript>":
version: 5.6.3
resolution: "typescript@patch:typescript@npm%3A5.6.3#optional!builtin<compat/typescript>::version=5.6.3&hash=5adc0c"
"typescript@patch:typescript@npm%3A~5.8.2#optional!builtin<compat/typescript>":
version: 5.8.2
resolution: "typescript@patch:typescript@npm%3A5.8.2#optional!builtin<compat/typescript>::version=5.8.2&hash=5786d5"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 10c0/ac8307bb06bbfd08ae7137da740769b7d8c3ee5943188743bb622c621f8ad61d244767480f90fbd840277fbf152d8932aa20c33f867dea1bb5e79b187ca1a92f
checksum: 10c0/5448a08e595cc558ab321e49d4cac64fb43d1fa106584f6ff9a8d8e592111b373a995a1d5c7f3046211c8a37201eb6d0f1566f15cdb7a62a5e3be01d087848e2
languageName: node
linkType: hard

Expand Down

0 comments on commit 698e4df

Please sign in to comment.