Skip to content

Commit d465d72

Browse files
committed
Add some iOS readme details
1 parent 8daf907 commit d465d72

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,17 @@ These properties are only accessible from the equivalent target's source set. Fo
268268
.build()
269269
```
270270

271+
### Running on iOS
272+
273+
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).
274+
275+
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`:
276+
```kotlin
277+
cocoapods {
278+
pod("FirebaseCore") // Repeat for Firebase pods required by your project, e.g FirebaseFirestore for the `firebase-firestore` module.
279+
}
280+
```
281+
271282
## Contributing
272283
If you'd like to contribute to this project then you can fork this repository.
273284
You can build and test the project locally.

0 commit comments

Comments
 (0)