Skip to content

Commit

Permalink
Add some iOS readme details
Browse files Browse the repository at this point in the history
  • Loading branch information
Daeda88 committed May 3, 2024
1 parent 8daf907 commit d465d72
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,17 @@ These properties are only accessible from the equivalent target's source set. Fo
.build()
```

### Running on iOS

On iOS the official [Firebase iOS SDK](https://github.com/firebase/firebase-ios-sdk) in not linked as a transtive dependency. Therefore, any project using this SDK needs to link the actual Firestore SDK as well. This can be done through your preferred installation method (Cocoapods/SPM).

Similarly, tests require linking as well. Make sure to add the required frameworks to the search path of your test targets. This can be done by specifying a `cocoapods` block in your `build.gradle`:
```kotlin
cocoapods {
pod("FirebaseCore") // Repeat for Firebase pods required by your project, e.g FirebaseFirestore for the `firebase-firestore` module.
}
```

## Contributing
If you'd like to contribute to this project then you can fork this repository.
You can build and test the project locally.
Expand Down

0 comments on commit d465d72

Please sign in to comment.