Skip to content

Commit 512ba3f

Browse files
authored
Some minor README cleanups (#7093)
1 parent 806951a commit 512ba3f

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,6 @@ support can be found at [SwiftPackageManager.md](SwiftPackageManager.md).
5959

6060
### Installing from GitHub
6161

62-
For releases starting with 5.0.0, the source for each release is also deployed
63-
to CocoaPods master and available via standard
64-
[CocoaPods Podfile syntax](https://guides.cocoapods.org/syntax/podfile.html#pod).
65-
6662
These instructions can be used to access the Firebase repo at other branches,
6763
tags, or commits.
6864

@@ -158,14 +154,6 @@ brew install mint
158154

159155
Select a scheme and press Command-u to build a component and run its unit tests.
160156

161-
#### Viewing Code Coverage (Deprecated)
162-
163-
First, make sure that [xcov](https://github.com/nakiostudio/xcov) is installed with `gem install xcov`.
164-
165-
After running the `AllUnitTests_iOS` scheme in Xcode, execute
166-
`xcov --workspace Firebase.xcworkspace --scheme AllUnitTests_iOS --output_directory xcov_output`
167-
at Example/ in the terminal. This will aggregate the coverage, and you can run `open xcov_output/index.html` to see the results.
168-
169157
### Running Sample Apps
170158
In order to run the sample apps and integration tests, you'll need a valid
171159
`GoogleService-Info.plist` file. The Firebase Xcode project contains dummy plist
@@ -213,7 +201,8 @@ In order to actually test receiving push notifications, you will need to:
213201
1. Change the bundle identifier of the sample app to something you own in your Apple Developer
214202
account, and enable that App ID for push notifications.
215203
2. You'll also need to
216-
[upload your APNs Provider Authentication Key or certificate to the Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs)
204+
[upload your APNs Provider Authentication Key or certificate to the
205+
Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs)
217206
at **Project Settings > Cloud Messaging > [Your Firebase App]**.
218207
3. Ensure your iOS device is added to your Apple Developer portal as a test device.
219208

@@ -230,20 +219,22 @@ very grateful! We'd like to empower as many developers as we can to be able to
230219
participate in the Firebase community.
231220

232221
### tvOS, macOS, watchOS and Catalyst
233-
Thanks to contributions from the community, many of Firebase SDKs now compile, run unit tests, and work on
234-
tvOS, macOS, watchOS and Catalyst.
235-
236-
For tvOS, checkout the [Sample](Example/tvOSSample).
237-
For watchOS, currently only Messaging, Storage and Crashlytics (and their dependencies) have limited support. Checkout the
238-
[Independent Watch App Sample](Example/watchOSSample).
239-
240-
Keep in mind that macOS, tvOS, watchOS and Catalyst are not officially supported by Firebase, and this
241-
repository is actively developed primarily for iOS. While we can catch basic unit test issues with
242-
Travis, there may be some changes where the SDK no longer works as expected on macOS, tvOS or watchOS. If you
243-
encounter this, please [file an issue](https://github.com/firebase/firebase-ios-sdk/issues).
244-
245-
During app setup in the console, you may get to a step that mentions something like "Checking if the app
246-
has communicated with our servers". This relies on Analytics and will not work on macOS/tvOS/watchOS/Catalyst.
222+
Thanks to contributions from the community, many of Firebase SDKs now compile, run unit tests, and
223+
work on tvOS, macOS, watchOS and Catalyst.
224+
225+
For tvOS, see the [Sample](Example/tvOSSample).
226+
For watchOS, currently only Messaging, Storage and Crashlytics (and their dependencies) have limited
227+
support. See the [Independent Watch App Sample](Example/watchOSSample).
228+
229+
Keep in mind that macOS, tvOS, watchOS and Catalyst are not officially supported by Firebase, and
230+
this repository is actively developed primarily for iOS. While we can catch basic unit test issues
231+
with GitHub Actions, there may be some changes where the SDK no longer works as expected on macOS,
232+
tvOS or watchOS. If you encounter this, please
233+
[file an issue](https://github.com/firebase/firebase-ios-sdk/issues).
234+
235+
During app setup in the console, you may get to a step that mentions something like "Checking if the
236+
app has communicated with our servers". This relies on Analytics and will not work on
237+
macOS/tvOS/watchOS/Catalyst.
247238
**It's safe to ignore the message and continue**, the rest of the SDKs will work as expected.
248239

249240
To install, add a subset of the following to the Podfile:
@@ -268,7 +259,8 @@ to Build Settings.
268259
[gRPC Resource target](https://github.com/firebase/firebase-ios-sdk/issues/3500#issuecomment-518741681).
269260

270261
#### Additional Crashlytics Notes
271-
* watchOS has limited support. Due to watchOS restrictions, mach exceptions and signal crashes are not recorded. (Crashes in SwiftUI are generated as mach exceptions, so will not be recorded)
262+
* watchOS has limited support. Due to watchOS restrictions, mach exceptions and signal crashes are
263+
not recorded. (Crashes in SwiftUI are generated as mach exceptions, so will not be recorded)
272264

273265
## Roadmap
274266

0 commit comments

Comments
 (0)