From 9ad0d5b1caf7b8580498f0d9dc82ad626f274eb3 Mon Sep 17 00:00:00 2001 From: Ibrahim Ulukaya Date: Mon, 27 Mar 2017 12:40:36 -0400 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index d0bc45583..d143d9d0c 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,24 @@ A collection of quickstart samples demonstrating the Firebase APIs on iOS. Each sample contains targets for both Objective-C and Swift. For more information, see https://firebase.google.com. +## Samples + +You can open each of the following samples as an Xcode project, and run +them on a mobile device or a simulator. Simply install the pods and open +the .xcworkspace file to see the project in Xcode. +``` +$ pod install +$ open your-project.xcworkspace +``` +When doing so you need to add each sample app you wish to try to a Firebase +project on the [Firebase console](https://console.firebase.google.com). +You can add multiple sample apps to the same Firebase project. +There's no need to create separate projects for each app. + +To add a sample app to a Firebase project, use the bundleID from the Xcode project. +Download the generated `GoogleService-Info.plist` file, and copy it to the root +directory of the sample you wish to run. + - [Admob](admob) - [Analytics](analytics) - [Authentication](authentication) @@ -19,3 +37,6 @@ Please read and follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md) ## License See [LICENSE](LICENSE) + +## Build Status +[![Build Status](https://travis-ci.org/firebase/quickstart-ios.svg?branch=master)](https://travis-ci.org/firebase/quickstart-ios)