Skip to content

Commit c47a19d

Browse files
rsattarpaulb777
authored andcommitted
Add section explaining community supported efforts (#63)
* Add section explaining community supported efforts * Suggestions by @ianbarber, @katowulf, and @salqadri
1 parent c61996b commit c47a19d

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,38 +46,63 @@ In order to run the sample apps and integration tests, you'll need valid
4646

4747
Some sample apps like Firebase Messaging ([Example/Messaging/App](Example/Messaging/App)) require special Apple capabilities, and you will have to change the sample app to use a unique bundle identifier that you can control in your own Apple Developer account.
4848

49-
See the sections below for any special instructions for those SDKs.
49+
## Specific Component Instructions
50+
See the sections below for any special instructions for those components.
5051

51-
## Firebase Auth
52+
### Firebase Auth
5253

5354
If you're doing specific Firebase Auth development, see
5455
[AuthSamples/README.md](AuthSamples/README.md) for instructions about
5556
building and running the FirebaseAuth pod along with various samples and tests.
5657

57-
## Firebase Database
58+
### Firebase Database
5859

5960
To run the Database Integration tests, make your database authentication rules
6061
[public](https://firebase.google.com/docs/database/security/quickstart).
6162

62-
## Firebase Storage
63+
### Firebase Storage
6364

6465
To run the Storage Integration tests, follow the instructions in
6566
[FIRStorageIntegrationTests.m](Example/Storage/Tests/Integration/FIRStorageIntegrationTests.m).
6667

67-
## Firebase Messaging
68+
### Firebase Messaging
6869

69-
### Push Notifications
70+
#### Push Notifications
7071

7172
Push notifications can only be delivered to specially provisioned App IDs in the developer portal. In order to actually test receiving push notifications, you will need to:
7273

7374
1. Change the bundle identifier of the sample app to something you own in your Apple Developer account, and enable that App ID for push notifications.
74-
2. You'll also need to [upload your APNs Provider Authentication token or certificate to the Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs) at **Project Settings > Cloud Messaging > [Your Firebase App]**.
75+
2. You'll also need to [upload your APNs Provider Authentication Key or certificate to the Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs) at **Project Settings > Cloud Messaging > [Your Firebase App]**.
7576
3. Ensure your iOS device is added to your Apple Developer portal as a test device.
7677

77-
### iOS Simulator
78+
#### iOS Simulator
7879

7980
The iOS Simulator cannot register for remote notifications, and will not receive push notifications. In order to receive push notifications, you'll have to follow the steps above and run the app on a physical device.
8081

82+
## Community Supported Efforts
83+
84+
We've seen an amazing amount of interest and contributions to improve the Firebase SDKs, and we are very grateful! We'd like to empower as many developers as we can to be able to use Firebase and participate in the Firebase community.
85+
86+
Note that if you are using CocoaPods and using the FirebaseDev podspec (the one in this repo), you cannot bring in Pods from the official Firebase podspec, because of duplicated symbol conflicts. If you're not using one of the open-source SDKs in this repo for development purposes, we recommend using the regular Firebase pods for the best experience.
87+
88+
To get started using the FirebaseDev SDKs, here is a typical Podfile:
89+
90+
```
91+
use_frameworks!
92+
93+
target 'MyAppTarget' do
94+
platform :ios, '8.0'
95+
pod 'FirebaseDev', :git => 'https://github.com/firebase/firebase-ios-sdk.git'
96+
end
97+
```
98+
Replace `MyAppTarget` with the name of the target in your Xcode project.
99+
100+
### macOS
101+
FirebaseAuth, FirebaseCore, FirebaseDatabase and FirebaseStorage now compile, run unit tests, and work on macOS, thanks to contributions from the community. There are a few tweaks needed, like ensuring iOS-only or macOS-only code is correctly guarded with checks for `TARGET_OS_IOS` and `TARGET_OS_OSX`.
102+
103+
Keep in mind that macOS is not officially supported by Firebase, and this repository is actively developed primarily for iOS. While we can catch basic unit test issues with Travis, there may be some changes where the SDK no longer works as expected on macOS. If you encounter this, please [file an issue](https://github.com/firebase/firebase-ios-sdk/issues) for it.
104+
105+
81106
## Contributing
82107

83108
See [Contributing](CONTRIBUTING.md) for more information on contributing to the Firebase

0 commit comments

Comments
 (0)