Skip to content

chore: enriched the documentation #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IronTony merged 3 commits into from
Apr 3, 2026
Merged

chore: enriched the documentation #249

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ba56e1
chore: enriched the documentation
IronTony Apr 2, 2026
67f2eba
docs(apple-signin): clarify key expiration and iOS version requiremen…
IronTony Apr 3, 2026
2e291e6
Merge branch 'main' into feat/apple-signin-doc-new
IronTony Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions packages/apple-signin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,20 @@ if (Platform.OS === 'ios') {
- **Credential State**: On iOS, you can check if the user's Apple ID is still authorized via `getCredentialState()`. This is used during token refresh instead of silent re-authentication.
- **No Client-Side Refresh**: Apple does not support client-side token refresh. When the identity token expires, the user must re-authenticate.

## Platform Notes

### Renewal & Maintenance

- Apple Sign-In **keys do not automatically expire**. Once generated, they remain valid until they are revoked or deleted.
- Your Services ID is tied to your Apple Developer Program membership, which renews annually. If your membership lapses, Sign in with Apple stops working for all your apps.
- There are no certificates to rotate specifically for Sign in with Apple (unlike APNs push certificates).

### iOS Version Notes

- Sign in with Apple is available on Apple platforms starting with **iOS 13+**, but this library currently requires **iOS 15.1+** on iOS because its CocoaPods deployment target is set to 15.1.
- On **iOS 15+**, Apple provides more reliable support for detecting credential state changes (for example, revoked or transferred credentials) via `getCredentialState()`.
- On native, `AppleSignInButton` is a custom React Native button styled for Sign in with Apple; its appearance is defined by this package rather than by Apple's `ASAuthorizationAppleIDButton`.

## API Reference

### Types
Expand Down
Loading