Skip to content

Commit

Permalink
SPM beta docs (#6312)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulb777 authored Aug 25, 2020
1 parent 54421ea commit 1e5c988
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions SwiftPackageManager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Swift Package Manager for Firebase **Beta**

## Introduction

Starting with the 6.31.0 release, Firebase supports installation via [Swift
Package Manager](https://swift.org/package-manager/) in Beta status.


## Limitations

- Requires at least Xcode 12 beta 4.
- SwiftUI Previews require Xcode 12 beta 5.
- Analytics requires clients to add `-ObjC` linker option.
- Analytics is only supported for iOS and cannot be used in apps that support other platforms.
- Messaging, Performance, Firebase ML, and App Distribution are not initially available.
- watchOS support is not initially available.

## Installation

If you've previously used CocoaPods, remove them from the project with `pod deintegrate`.

Install Firebase via Swift Package Manager:

<img src="docs/resources/SPMAddPackage.png">

Select the Firebase GitHub repository - `https://github.com/firebase/firebase-ios-sdk.git`:

<img src="docs/resources/SPMChoose.png">

Select the beta branch.

Note: Starting with the 6.31.0 release, the versions are specified
in a format like 6.31-spm-beta. We won't support standard repository
versioning until later in the beta or with general availability of the SPM
distribution.

<img src="docs/resources/SPMSelect.png">

Choose the Firebase product and any additional products that you want installed
in your app.

<img src="docs/resources/SPMProducts.png">

If you've installed FirebaseAnalytics, Add the `-ObjC` option to `Other Linker Flags`
in the `Build Settings` tab.

<img src="docs/resources/SPMObjC.png">

## Questions and Issues

Please provide any feedback via a [GitHub
Issue](https://github.com/firebase/firebase-ios-sdk/issues/new?template=bug_report.md).

See current open Swift Package Manager issues
[here](https://github.com/firebase/firebase-ios-sdk/labels/Swift%20Package%20Manager).
Binary file added docs/resources/SPMAddPackage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/resources/SPMChoose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/resources/SPMObjC.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/resources/SPMProducts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/resources/SPMSelect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e5c988

Please sign in to comment.