Skip to content

Commit 2261dfd

Browse files
authored
Merge pull request #816 from firebase/readmes
Add OAuth and Sign In with Apple to README
2 parents 0cdcaf9 + 70f6806 commit 2261dfd

File tree

2 files changed

+25
-9
lines changed

2 files changed

+25
-9
lines changed

Auth/README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ FirebaseUI can be easily customized to fit in with the rest of your app's visual
1818
style, and it is open source, so you aren't constrained in realizing the user
1919
experience you want.
2020

21-
Compatible FirebaseUI clients are also available for [Android](https://github.com/firebase/firebaseui-android/tree/master/auth)
21+
Compatible FirebaseUI Auth clients are also available for
22+
[Android](https://github.com/firebase/firebaseui-android/tree/master/auth)
2223
and [Web](https://github.com/firebase/firebaseui-web/).
2324

2425
## Table of Contents
@@ -49,6 +50,8 @@ Auth guides at the following links:
4950
- [Google](https://firebase.google.com/docs/auth/ios/google-signin#before_you_begin)
5051
- [Facebook](https://firebase.google.com/docs/auth/ios/facebook-login#before_you_begin)
5152
- [Phone](https://firebase.google.com/docs/auth/ios/phone-auth#before_you_begin)
53+
- [Sign in with Apple](https://firebase.google.com/docs/auth/ios/apple#before_you_begin)
54+
- For Sign in with Apple, read the [Comply with Apple anonymized data requirements](https://firebase.google.com/docs/auth/ios/apple#comply-with-apple-anonymized-data-requirements) section as well.
5255

5356
## Using FirebaseUI for Authentication
5457

@@ -95,8 +98,13 @@ let providers: [FUIAuthProvider] = [
9598
FUIGoogleAuth(),
9699
FUIFacebookAuth(),
97100
FUIPhoneAuth(authUI: FUIAuth.defaultAuthUI()),
101+
FUIOAuth.appleAuthProvider(),
102+
FUIOAuth.twitterAuthProvider(),
103+
FUIOAuth.githubAuthProvider(),
104+
FUIOAuth.microsoftAuthProvider(),
105+
FUIOAuth.yahooAuthProvider(),
98106
]
99-
self.authUI?.providers = providers
107+
authUI?.providers = providers
100108
```
101109

102110
```objective-c
@@ -109,14 +117,21 @@ NSArray<id<FUIAuthProvider>> *providers = @[
109117
[[FUIEmailAuth alloc] init],
110118
[[FUIGoogleAuth alloc] init],
111119
[[FUIFacebookAuth alloc] init],
112-
[[FUIPhoneAuth alloc] initWithAuthUI:[FUIAuth defaultAuthUI]]
120+
[[FUIPhoneAuth alloc] initWithAuthUI:[FUIAuth defaultAuthUI]],
121+
[FUIOAuth appleAuthProvider],
122+
[FUIOAuth twitterAuthProvider],
123+
[FUIOAuth githubAuthProvider],
124+
[FUIOAuth microsoftAuthProvider],
125+
[FUIOAuth yahooAuthProvider]
113126
];
114-
_authUI.providers = providers;
127+
self.authUI.providers = providers;
115128
```
116129

117130
For Google Sign-in support, add custom URL schemes to your Xcode project
118131
(step 1 of the [implement Google Sign-In documentation](https://developers.google.com/firebase/docs/auth/ios/google-signin#2_implement_google_sign-in)).
119132

133+
For Sign in with Apple support, add the Sign in with Apple capability to your entitlements file.
134+
120135
For Facebook Login support, follow step 3 and 4 of
121136
[Facebook login documentation](https://developers.google.com/firebase/docs/auth/ios/facebook-login#before_you_begin),
122137
and follow the [Facebook SDK for iOS Getting started documentation](https://developers.facebook.com/docs/ios/getting-started).

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ FirebaseUI supports iOS 8.0+. We recommend using [CocoaPods](https://cocoapods.o
1414
the following to your `Podfile`:
1515

1616
```ruby
17-
pod 'FirebaseUI', '~> 5.0' # Pull in all Firebase UI features
17+
pod 'FirebaseUI', '~> 8.0' # Pull in all Firebase UI features
1818
```
1919

2020
If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:
2121

2222
```ruby
23-
# Only pull in FirebaseUI Firestore features
23+
# Only pull in Firestore features
2424
pod 'FirebaseUI/Firestore', '~> 8.0'
2525

26-
# Only pull in FirebaseUI Database features
26+
# Only pull in Database features
2727
pod 'FirebaseUI/Database', '~> 8.0'
2828

29-
# Only pull in FirebaseUI Storage features
29+
# Only pull in Storage features
3030
pod 'FirebaseUI/Storage', '~> 8.0'
3131

32-
# Only pull in FirebaseUI Auth features
32+
# Only pull in Auth features
3333
pod 'FirebaseUI/Auth', '~> 8.0'
3434

3535
# Only pull in Facebook login features
@@ -73,6 +73,7 @@ following commands to get your environment set up:
7373
```bash
7474
$ git clone https://github.com/firebase/FirebaseUI-iOS.git
7575
$ cd FirebaseUI-iOS
76+
$ cd Auth # or PhoneAuth, Database, etc
7677
$ pod install
7778
```
7879

0 commit comments

Comments
 (0)