aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Paul Beusterien <paulbeusterien@google.com>2018-07-13 06:52:41 -0700
committerGravatar GitHub <noreply@github.com>2018-07-13 06:52:41 -0700
commit1077b28f6212c17fc4f408c42ca64ada8d5effed (patch)
tree4fe7976644eeabf68b14fcc708d9cf45a2d06319
parentc586dc8747882770973b6488c9f5f9e6e3f08d6c (diff)
Simplify README now that source pods are default (#1526)
-rw-r--r--README.md45
1 files changed, 11 insertions, 34 deletions
diff --git a/README.md b/README.md
index 39db2f5..4a5f457 100644
--- a/README.md
+++ b/README.md
@@ -35,48 +35,22 @@ See
[the Podfile Syntax Reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
for instructions and options about overriding pod source locations.
-#### Step-by-step Source Pod Installation Instructions
+#### Accessing Firebase Source Snapshots
-For iOS, copy a subset of the following lines to your Podfile:
+All of the official releases are tagged in this repo and available via CocoaPods. To access a local
+source snapshot or unreleased branch, use Podfile directives like the following:
+To access FirebaseFirestore via a branch:
```
-pod 'Firebase' # To enable Firebase module, with `@import Firebase` support
-pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseAuth', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseDatabase', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseFunctions', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseMessaging', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseStorage', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-```
-
-For macOS and tvOS, copy a subset of the following:
-
-```
-pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseAuth', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseDatabase', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
-pod 'FirebaseStorage', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :tag => '5.0.0'
+pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
+pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
```
-1. Make sure you have at least CocoaPods version 1.4.0 - `pod --version`.
-1. Delete pods for any components you don't need, except `FirebaseCore` must always be included.
-1. Update the tags to the latest Firebase release. See the
-[release notes](https://firebase.google.com/support/release-notes/ios).
-1. Run `pod update`.
-
-#### Examples
-
To access FirebaseMessaging via a checked out version of the firebase-ios-sdk repo do:
```
-pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'
pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
-```
-To access via a branch:
-```
-pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
-pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
+pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'
```
### Carthage (iOS only)
@@ -177,7 +151,10 @@ actively developed primarily for iOS. While we can catch basic unit test issues
may be some changes where the SDK no longer works as expected on macOS or tvOS. If you encounter
this, please [file an issue](https://github.com/firebase/firebase-ios-sdk/issues).
-For installation instructions, see [above](README.md#step-by-step-source-pod-installation-instructions).
+For installation instructions, see [above](README.md#accessing-firebase-source-snapshots).
+
+Note that the Firebase pod is not available for macOS and tvOS. Install a selection of the
+`FirebaseAuth`, `FirebaseCore`, `FirebaseDatabase` and `FirebaseStorage` CocoaPods.
## Roadmap