Skip to content

Commit e3b2cae

Browse files
committed
Fix some README issues
Change-Id: I3ea39e01f30a6e909d4cb6f481ab5a5f705819da
1 parent 3ba9d9b commit e3b2cae

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

FirebaseAuthUI/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Auth guides at the following links:
5555
### Configuration
5656

5757
All operations, callbacks, UI customizations are done through an `FUIAuth`
58-
instance. The `FUIAuth` instance associated with the default `FIRAuth`
58+
instance. The `FUIAuth` instance associated with the default Firebase Auth
5959
instance can be accessed as follows:
6060

6161
```swift
@@ -90,7 +90,7 @@ let providers: [FUIAuthProvider] = [
9090
FUIGoogleAuth(),
9191
FUIFacebookAuth(),
9292
FUITwitterAuth(),
93-
FUIPhoneAuth(authUI:FUIAuth.defaultAuthUI()),
93+
FUIPhoneAuth(authUI: FUIAuth.defaultAuthUI()),
9494
]
9595
self.authUI?.providers = providers
9696
```
@@ -154,7 +154,7 @@ present the `authViewController` obtain as instance as follows:
154154
// Present the auth view controller and then implement the sign in callback.
155155
let authViewController = authUI!.authViewController()
156156

157-
func authUI(_ authUI: FUIAuth, didSignInWithAuthDataResult authDataResult: FIRAuthDataResult?, error: Error?){
157+
func authUI(_ authUI: FUIAuth, didSignInWithAuthDataResult authDataResult: AuthDataResult?, error: Error?) {
158158
// handle user (`authDataResult.user`) and error as necessary
159159
}
160160
```

FirebasePhoneAuthUI/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ In order to use Phone Auth you should initialize Phone provider and add it to th
3131
```swift
3232
// Swift
3333
import Firebase
34-
import FirebaseAuthUI
35-
import FirebasePhoneAuthUI
34+
import FirebaseUI
3635

3736
/* ... */
3837

@@ -43,8 +42,7 @@ FUIAuth.defaultAuthUI()?.providers = [phoneProvider]
4342

4443
```objective-c
4544
// Objective-C
46-
@import FirebaseAuthUI; // OR #import <FirebaseAuthUI/FirebaseAuthUI.h>
47-
@import FirebasePhoneAuthUI; // OR #import <FirebasePhoneAuthUI/FUIPhoneAuth.h>
45+
@import FirebaseUI;
4846

4947
/* ... */
5048

@@ -55,7 +53,7 @@ FUIPhoneAuth *phoneProvider = [[FUIPhoneAuth alloc] initWithAuthUI:[FUIAuth defa
5553
5654
### Sign In
5755
58-
To start the authentication flow:
56+
To start the authentication flow:
5957
6058
```swift
6159
// Swift
@@ -69,9 +67,6 @@ FUIPhoneAuth *phoneProvider = [FUIAuth defaultAuthUI].providers.firstObject;
6967
[phoneProvider signInWithPresentingViewController:currentlyVisibleController phoneNumber:nil];
7068
```
7169
72-
## Customizing
73-
Customizing of Phone Auth is planned to be implemented in 2017 Q4
74-
7570
## Integration cheat sheet
7671
Here you can find steps things that need to be checked in case of any issues with Firebase Phone Auth integration problems.
7772
@@ -85,7 +80,7 @@ In case need to handle push notifications yourself:
8580
<br>In this case The type of the token (production or sandbox) will be attempted to be automatically detected. There is other method to set it manually.
8681
1. In the `AppDelegate` `application:didReceiveRemoteNotification:fetchCompletionHandler:` call `[FUIAuth.defaultAuthUI.auth canHandleNotification:userInfo]`
8782
1. In the `AppDelegate` `application:didFinishLaunchingWithOptions:` call `[FIRApp configure]`
88-
1. In the `AppDelegate` `application:openURL:options:` return `[FUIAuth.defaultAuthUI handleOpenURL:url sourceApplication:sourceApplication]`
83+
1. In the `AppDelegate` `application:openURL:options:` return `[FUIAuth.defaultAuthUI handleOpenURL:url sourceApplication:sourceApplication]`
8984
1. Add `REVERSED_CLIENT_ID` as URL scheme to `Project settings`
9085
1. Add `GoogleService-Info.plist` to your project
9186
1. In you controller call:
@@ -105,4 +100,4 @@ You can skip all errors, FirbaseUI Phone Auth will display all error messages fo
105100
If you don't need to handle APNS yourself, than don't do steps 3, 4, 5.
106101
107102
Please notice that you can use either APNS key OR APNS certificate.
108-
<br>One APNS Key can be used for all your iOS app from the same Apple Developer account.
103+
<br>One APNS Key can be used for all your iOS app from the same Apple Developer account.

0 commit comments

Comments
 (0)