Skip to content

Commit def681a

Browse files
committed
Cleaning up FirebaseUI IOS sample READMEs:
* Fixing grammatical errors in objc, swift, top-level READMEs * Adding some extra links/sentences to top-level README * Adding more content to swift README (copied from objc)
1 parent 73af689 commit def681a

File tree

3 files changed

+30
-16
lines changed

3 files changed

+30
-16
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,10 @@ Alternatively you can use `pod try FirebaseUI` to install the Objective-C or Swi
6666

6767
## Mandatory Sample Project Configuration
6868

69-
You have to configure Xcode project in order to run samples.
69+
You have to configure your Xcode project in order to run samples.
7070

71-
1. You project should contain `GoogleService-Info.plist` downloaded from [Firebase console](https://console.firebase.google.com).<br>
72-
Copy `GoogleService-Info.plist` into sample project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).<br>
73-
Find more instructions and download a plist file from the [Firebase console](https://console.firebase.google.com).
71+
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>
72+
Copy `GoogleService-Info.plist` into sample the project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).
7473

7574
2. Update URL Types.<br>
7675
Go to `Project Settings -> Info tab -> Url Types` and update values for:
@@ -87,7 +86,7 @@ Facebook SDK requires keychain sharing.<br>
8786
This can be done here: `Project Settings -> Capabilities -> KeyChain Sharing -> ON`
8887

8988
5. Don't forget to configure your Firebase App Database using [Firebase console](https://console.firebase.google.com).<br>
90-
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectfully)
89+
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectively)
9190

9291
## Contributing to FirebaseUI
9392

samples/objc/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
FirebaseUI Chat Demo
2-
====================
1+
FirebaseUI Chat Demo in Objective C
2+
===================================
33

4-
This is a super simple FirebaseUI Chat demo. It shows:
4+
This is a super simple FirebaseUI Chat demo in Objective C. It shows:
55
1. The ease of integrating with FirebaseUI
66
1. Using a `UITableView` outside of a `UITableViewController`
77
1. Using custom XIBs in FirebaseUI to achieve a custom look and feel
@@ -20,7 +20,7 @@ Once you've opened the workspace, go into `Supporting Files/Info.plist` and eith
2020

2121
###Project configuration
2222

23-
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
23+
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project.
2424

2525
###Chat Sample
2626

@@ -38,3 +38,8 @@ The auth example requires a little more setup (adding url schemes, etc)
3838
since it depends on the various keys and tokens for the different auth
3939
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
4040
for more information.
41+
42+
###Storage Sample
43+
44+
This sample does not use a logged-in user, so make to set up the [Storage Security Rules](https://firebase.google.com/docs/storage/security/start#sample-rules)
45+
for your bucket to allow that.

samples/swift/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
Swift Samples
2-
-----
1+
FirebaseUI Chat Demo in Swift
2+
=============================
33

44
This directory contains a collection of swift code samples.
55

6-
###Project configuration
7-
8-
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
6+
In order to install and run:
7+
``` bash
8+
git clone https://github.com/firebase/FirebaseUI-iOS.git
9+
cd FirebaseUI-iOS/samples/swift
10+
pod install
11+
open FirebaseUI-demo-swift.xcworkspace
12+
```
13+
Once you've opened the workspace, go into `Supporting Files/Info.plist` and either fill in the social provider information currently commented out, or delete extra providers you're not interested in. For providers you choose to keep, enable them in your Firebase Dashboard according to the [user authentication docs](https://www.firebase.com/docs/ios/guide/user-auth.html). In `ViewController.m` make sure to only enable providers that you've configured properly.
914

1015
###Project configuration
1116

12-
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
17+
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project.
1318

1419
###Chat Sample
1520

@@ -25,5 +30,10 @@ auth, so make sure those are enabled in Firebase console.
2530

2631
The auth example requires a little more setup (adding url schemes, etc)
2732
since it depends on the various keys and tokens for the different auth
28-
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
33+
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
2934
for more information.
35+
36+
###Storage Sample
37+
38+
This sample does not use a logged-in user, so make to set up the [Storage Security Rules](https://firebase.google.com/docs/storage/security/start#sample-rules)
39+
for your bucket to allow that.

0 commit comments

Comments
 (0)