Skip to content

Commit 42816a5

Browse files
committed
Update docs
Change-Id: Ida545664e1bd56668ee422cbff9dd6ebe5720894
1 parent e32847a commit 42816a5

File tree

3 files changed

+18
-20
lines changed

3 files changed

+18
-20
lines changed

FirebaseAuthUI/README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ instance can be accessed as follows:
6060

6161
```swift
6262
// Swift
63-
import Firebase
64-
import FirebaseAuthUI
63+
import FirebaseUI
6564

6665
/* ... */
6766

@@ -73,8 +72,7 @@ authUI?.delegate = self
7372

7473
```objective-c
7574
// Objective-C
76-
@import Firebase;
77-
@import FirebaseAuthUI;
75+
@import FirebaseUI;
7876
...
7977
[FIRApp configure];
8078
FUIAuth *authUI = [FUIAuth defaultAuthUI];
@@ -86,10 +84,7 @@ This instance can then be configured with the providers you wish to support:
8684

8785
```swift
8886
// Swift
89-
import FirebaseGoogleAuthUI
90-
import FirebaseFacebookAuthUI
91-
import FirebaseTwitterAuthUI
92-
import FirebasePhoneAuthUI
87+
import FirebaseUI
9388

9489
let providers: [FUIAuthProvider] = [
9590
FUIGoogleAuth(),
@@ -102,11 +97,10 @@ self.authUI?.providers = providers
10297

10398
```objective-c
10499
// Objective-C
105-
@import FirebaseGoogleAuthUI;
106-
@import FirebaseFacebookAuthUI;
107-
@import FirebaseTwitterAuthUI;
108-
@import FirebasePhoneAuthUI;
109-
...
100+
@import FirebaseUI;
101+
102+
// ...
103+
110104
NSArray<id<FUIAuthProvider>> *providers = @[
111105
[[FUIGoogleAuth alloc] init],
112106
[[FUIFacebookAuth alloc] init],

FirebaseStorageUI/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ UIImageView *imageView = ...;
3434
let reference: StorageReference = ...;
3535
3636
// UIImageView in your ViewController
37-
var imageView: UIImageView = ...;
37+
let imageView: UIImageView = ...;
3838
3939
// Load the image using SDWebImage
4040
imageView.sd_setImageWithStorageReference(reference, placeholderImage: placeholderImage)

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ pod 'FirebaseUI', '~> 5.0' # Pull in all Firebase UI features
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
24+
pod 'FirebaseUI/Firestore', '~> 5.0'
25+
2326
# Only pull in FirebaseUI Database features
2427
pod 'FirebaseUI/Database', '~> 5.0'
2528

@@ -60,6 +63,7 @@ The READMEs for components of FirebaseUI can be found in their respective
6063
project folders.
6164

6265
- [Auth](FirebaseAuthUI/README.md)
66+
- [Firestore](FirebaseFirestoreUI/README.md)
6367
- [PhoneAuth](FirebasePhoneAuthUI/README.md)
6468
- [Database](FirebaseDatabaseUI/README.md)
6569
- [Firestore](FirebaseFirestoreUI/README.md)
@@ -78,22 +82,22 @@ $ pod install
7882

7983
Alternatively you can use `pod try FirebaseUI` to install the Objective-C or Swift sample projects.
8084

81-
## Mandatory Sample Project Configuration
85+
## Sample Project Configuration
8286

83-
You have to configure your Xcode project in order to run samples.
87+
You'll have to configure your Xcode project in order to run the samples.
8488

85-
1. Your Xcode project should contain `GoogleService-Info.plist`, downloaded from [Firebase console](https://console.firebase.google.com) when you add your app to a Firebase project.<br>
86-
Copy `GoogleService-Info.plist` into sample the project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).
89+
1. Your Xcode project should contain a `GoogleService-Info.plist`, downloaded from [Firebase console](https://console.firebase.google.com) when you add your app to a Firebase project.<br>
90+
Copy the `GoogleService-Info.plist` into the sample project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).
8791

8892
1. Update URL Types.<br>
8993
Go to `Project Settings -> Info tab -> Url Types` and update values for:
9094
+ `REVERSED_CLIENT_ID` (get value from `GoogleService-Info.plist`)
9195
+ `fb{your-app-id}` (put Facebook App Id)
9296
+ `twitterkit-{consumer-key}` (put Twitter App Consumer key)
9397

94-
1. Update `Info.plist` twitter and facebook configuration values
98+
1. Update `Info.plist` with Twitter and Tacebook configuration values
9599
+ `FacebookAppID -> {your-app-id}` (put Facebook App Id)
96-
+ `Fabric -> Kits -> KitInfo -> consumerKey / consumerSecret` (put Twitter App consumer key/secret). Please note that's it's not secure to store `consumerSecret` in the app itself.
100+
+ `Fabric -> Kits -> KitInfo -> consumerKey / consumerSecret` (put Twitter App consumer key/secret). Please note that's it's not secure to store the `consumerSecret` in the app itself.
97101

98102
1. Enable Keychain Sharing.<br>
99103
Facebook SDK requires keychain sharing.<br>

0 commit comments

Comments
 (0)