From def681a94923c1ed8c2725230c509fa2a2d4d12a Mon Sep 17 00:00:00 2001 From: Kalpana Suraesh Date: Thu, 2 Mar 2017 11:56:37 -0800 Subject: [PATCH] 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) --- README.md | 9 ++++----- samples/objc/README.md | 13 +++++++++---- samples/swift/README.md | 24 +++++++++++++++++------- 3 files changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 943664ee356..25fa16f6450 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,10 @@ Alternatively you can use `pod try FirebaseUI` to install the Objective-C or Swi ## Mandatory Sample Project Configuration -You have to configure Xcode project in order to run samples. +You have to configure your Xcode project in order to run samples. -1. You project should contain `GoogleService-Info.plist` downloaded from [Firebase console](https://console.firebase.google.com).
-Copy `GoogleService-Info.plist` into sample project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).
-Find more instructions and download a plist file from the [Firebase console](https://console.firebase.google.com). +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.
+Copy `GoogleService-Info.plist` into sample the project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`). 2. Update URL Types.
Go to `Project Settings -> Info tab -> Url Types` and update values for: @@ -87,7 +86,7 @@ Facebook SDK requires keychain sharing.
This can be done here: `Project Settings -> Capabilities -> KeyChain Sharing -> ON` 5. Don't forget to configure your Firebase App Database using [Firebase console](https://console.firebase.google.com).
-Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectfully) +Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectively) ## Contributing to FirebaseUI diff --git a/samples/objc/README.md b/samples/objc/README.md index 8d837a8e4eb..1b85d528cb1 100644 --- a/samples/objc/README.md +++ b/samples/objc/README.md @@ -1,7 +1,7 @@ -FirebaseUI Chat Demo -==================== +FirebaseUI Chat Demo in Objective C +=================================== -This is a super simple FirebaseUI Chat demo. It shows: +This is a super simple FirebaseUI Chat demo in Objective C. It shows: 1. The ease of integrating with FirebaseUI 1. Using a `UITableView` outside of a `UITableViewController` 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 ###Project configuration -Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project. +Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project. ###Chat Sample @@ -38,3 +38,8 @@ The auth example requires a little more setup (adding url schemes, etc) since it depends on the various keys and tokens for the different auth services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md) for more information. + +###Storage Sample + +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) +for your bucket to allow that. \ No newline at end of file diff --git a/samples/swift/README.md b/samples/swift/README.md index 0fe0f321c55..1a71e4136f5 100644 --- a/samples/swift/README.md +++ b/samples/swift/README.md @@ -1,15 +1,20 @@ -Swift Samples ------ +FirebaseUI Chat Demo in Swift +============================= This directory contains a collection of swift code samples. -###Project configuration - -Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project. +In order to install and run: +``` bash +git clone https://github.com/firebase/FirebaseUI-iOS.git +cd FirebaseUI-iOS/samples/swift +pod install +open FirebaseUI-demo-swift.xcworkspace +``` +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. ###Project configuration -Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project. +Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project. ###Chat Sample @@ -25,5 +30,10 @@ auth, so make sure those are enabled in Firebase console. The auth example requires a little more setup (adding url schemes, etc) since it depends on the various keys and tokens for the different auth -services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md) +services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md) for more information. + +###Storage Sample + +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) +for your bucket to allow that. \ No newline at end of file