Skip to content

Commit 45eeb54

Browse files
authored
Add FirebaseFirestoreSwift readme (#5698)
* Add FirebaseFirestoreSwift readme * fix nit * address more review feedback
1 parent 9e46a62 commit 45eeb54

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

Firestore/Swift/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Firestore Swift Extensions
2+
3+
This directory contains source files for Firestore's Swift extensions SDK.
4+
5+
## Installation
6+
7+
The FirebaseFirestoreSwift module is currently only available for installation
8+
through CocoaPods. To add FirebaseFirestoreSwift to your project, add the
9+
following to your Podfile
10+
11+
```ruby
12+
pod 'FirebaseFirestoreSwift'
13+
```
14+
15+
You will need to import the FirebaseFirestoreSwift module in any source file
16+
that depends on it, since it's not automatically bundled with the Firestore
17+
module.
18+
19+
```swift
20+
import Firebase
21+
import FirebaseFirestoreSwift
22+
```
23+
24+
The FirebaseFirestoreSwift module does not provide any additional utility to
25+
Objective-C projects, and therefore is not recommended for non-Swift projects.
26+
27+
## Examples
28+
29+
See the
30+
[Firestore quickstart sample](https://github.com/firebase/quickstart-ios/tree/master/firestore/FirestoreExample)
31+
and the
32+
[official Firebase documentation](https://firebase.google.com/docs/firestore/manage-data/add-data#custom_objects)
33+
for usage examples.
34+
35+
## License
36+
37+
The Firestore Swift Extensions SDK is available under the Apache-2 license. See
38+
the top-level LICENSE file for more details.

0 commit comments

Comments
 (0)