Skip to content

Commit acf4b82

Browse files
fixed a few grammatical mistakes README.md (#11582)
1 parent d7173ec commit acf4b82

File tree

1 file changed

+40
-41
lines changed

1 file changed

+40
-41
lines changed

README.md

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
# Firebase Apple Open Source Development
2020

21-
This repository contains all Apple platform Firebase SDK source except FirebaseAnalytics.
21+
This repository contains the source code for all Apple platform Firebase SDKs except FirebaseAnalytics.
2222

23-
Firebase is an app development platform with tools to help you build, grow and
23+
Firebase is an app development platform with tools to help you build, grow, and
2424
monetize your app. More information about Firebase can be found on the
2525
[official Firebase website](https://firebase.google.com).
2626

@@ -29,20 +29,21 @@ monetize your app. More information about Firebase can be found on the
2929
See the subsections below for details about the different installation methods. Where
3030
available, it's recommended to install any libraries with a `Swift` suffix to get the
3131
best experience when writing your app in Swift.
32+
3233
1. [Standard pod install](#standard-pod-install)
33-
1. [Swift Package Manager](#swift-package-manager)
34-
1. [Installing from the GitHub repo](#installing-from-github)
35-
1. [Experimental Carthage](#carthage-ios-only)
34+
2. [Swift Package Manager](#swift-package-manager)
35+
3. [Installing from the GitHub repo](#installing-from-github)
36+
4. [Experimental Carthage](#carthage-ios-only)
3637

3738
### Standard pod install
3839

39-
Go to
40+
For instructions on the standard pod install, visit:
4041
[https://firebase.google.com/docs/ios/setup](https://firebase.google.com/docs/ios/setup).
4142

4243
### Swift Package Manager
4344

4445
Instructions for [Swift Package Manager](https://swift.org/package-manager/) support can be
45-
found at [SwiftPackageManager](SwiftPackageManager.md) Markdown file.
46+
found in the [SwiftPackageManager.md](SwiftPackageManager.md) Markdown file.
4647

4748
### Installing from GitHub
4849

@@ -51,13 +52,12 @@ tags, or commits.
5152

5253
#### Background
5354

54-
See
55-
[the Podfile Syntax Reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
55+
See [the Podfile Syntax Reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
5656
for instructions and options about overriding pod source locations.
5757

5858
#### Accessing Firebase Source Snapshots
5959

60-
All of the official releases are tagged in this repo and available via CocoaPods. To access a local
60+
All official releases are tagged in this repo and available via CocoaPods. To access a local
6161
source snapshot or unreleased branch, use Podfile directives like the following:
6262

6363
To access FirebaseFirestore via a branch:
@@ -66,37 +66,36 @@ pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git',
6666
pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
6767
```
6868

69-
To access FirebaseMessaging via a checked out version of the firebase-ios-sdk repo do:
70-
69+
To access FirebaseMessaging via a checked-out version of the firebase-ios-sdk repo:
7170
```ruby
7271
pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
7372
pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'
7473
```
7574

7675
### Carthage (iOS only)
7776

78-
Instructions for the experimental Carthage distribution are at
79-
[Carthage](Carthage.md).
77+
Instructions for the experimental Carthage distribution can be found at
78+
[Carthage.md](Carthage.md).
8079

8180
### Using Firebase from a Framework or a library
8281

83-
[Using Firebase from a Framework or a library](docs/firebase_in_libraries.md)
82+
For details on using Firebase from a Framework or a library, refer to [firebase_in_libraries.md](docs/firebase_in_libraries.md).
8483

8584
## Development
8685

8786
To develop Firebase software in this repository, ensure that you have at least
8887
the following software:
8988

90-
* Xcode 14.1 (or later)
89+
* Xcode 14.1 (or later)
9190

9291
CocoaPods is still the canonical way to develop, but much of the repo now supports
9392
development with Swift Package Manager.
9493

9594
### CocoaPods
9695

97-
Install
98-
* CocoaPods 1.10.0 (or later)
99-
* [CocoaPods generate](https://github.com/square/cocoapods-generate)
96+
Install the following:
97+
* CocoaPods 1.10.0 (or later)
98+
* [CocoaPods generate](https://github.com/square/cocoapods-generate)
10099

101100
For the pod that you want to develop:
102101

@@ -111,7 +110,7 @@ Note: Set the `--platforms` option to `macos` or `tvos` to develop/test for
111110
those platforms. Since 10.2, Xcode does not properly handle multi-platform
112111
CocoaPods workspaces.
113112

114-
Firestore has a self contained Xcode project. See
113+
Firestore has a self-contained Xcode project. See
115114
[Firestore/README](Firestore/README.md) Markdown file.
116115

117116
#### Development for Catalyst
@@ -123,7 +122,7 @@ Firestore has a self contained Xcode project. See
123122
* Select the Unit-unit scheme
124123
* Run it to build and test
125124

126-
Alternatively disable signing in each target:
125+
Alternatively, disable signing in each target:
127126
* Go to Build Settings tab
128127
* Click `+`
129128
* Select `Add User-Defined Setting`
@@ -138,19 +137,19 @@ Alternatively disable signing in each target:
138137

139138
### Adding a New Firebase Pod
140139

141-
See [AddNewPod](AddNewPod.md) Markdown file.
140+
Refer to [AddNewPod](AddNewPod.md) Markdown file for details.
142141

143142
### Managing Headers and Imports
144143

145-
See [HeadersImports](HeadersImports.md) Markdown file.
144+
For information about managing headers and imports, see [HeadersImports](HeadersImports.md) Markdown file.
146145

147146
### Code Formatting
148147

149148
To ensure that the code is formatted consistently, run the script
150149
[./scripts/check.sh](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/check.sh)
151-
before creating a PR.
150+
before creating a pull request (PR).
152151

153-
GitHub Actions will verify that any code changes are done in a style compliant
152+
GitHub Actions will verify that any code changes are done in a style-compliant
154153
way. Install `clang-format` and `mint`:
155154

156155
```console
@@ -163,28 +162,28 @@ brew install mint
163162
Select a scheme and press Command-u to build a component and run its unit tests.
164163

165164
### Running Sample Apps
166-
In order to run the sample apps and integration tests, you'll need a valid
167-
`GoogleService-Info.plist` file. The Firebase Xcode project contains dummy plist
168-
files without real values, but can be replaced with real plist files. To get your own
165+
To run the sample apps and integration tests, you'll need a valid
166+
`GoogleService-Info.plist
167+
` file. The Firebase Xcode project contains dummy plist
168+
files without real values, but they can be replaced with real plist files. To get your own
169169
`GoogleService-Info.plist` files:
170170

171171
1. Go to the [Firebase Console](https://console.firebase.google.com/)
172172
2. Create a new Firebase project, if you don't already have one
173173
3. For each sample app you want to test, create a new Firebase app with the sample app's bundle
174-
identifier (e.g. `com.google.Database-Example`)
174+
identifier (e.g., `com.google.Database-Example`)
175175
4. Download the resulting `GoogleService-Info.plist` and add it to the Xcode project.
176176

177177
### Coverage Report Generation
178178

179-
See [scripts/code_coverage_report/README](scripts/code_coverage_report/README.md) Markdown file.
179+
For coverage report generation instructions, see [scripts/code_coverage_report/README](scripts/code_coverage_report/README.md) Markdown file.
180180

181181
## Specific Component Instructions
182182
See the sections below for any special instructions for those components.
183183

184184
### Firebase Auth
185185

186-
If you're doing specific Firebase Auth development, see
187-
[the Auth Sample README](FirebaseAuth/Tests/Sample/README.md) for instructions about
186+
For specific Firebase Auth development, refer to the [Auth Sample README](FirebaseAuth/Tests/Sample/README.md) for instructions about
188187
building and running the FirebaseAuth pod along with various samples and tests.
189188

190189
### Firebase Database
@@ -195,13 +194,14 @@ or against a production instance.
195194
To run against a local emulator instance, invoke `./scripts/run_database_emulator.sh start` before
196195
running the integration test.
197196

198-
To run against a production instance, provide a valid GoogleServices-Info.plist and copy it to
197+
To run against a production instance, provide a valid `GoogleServices-Info.plist` and copy it to
199198
`FirebaseDatabase/Tests/Resources/GoogleService-Info.plist`. Your Security Rule must be set to
200199
[public](https://firebase.google.com/docs/database/security/quickstart) while your tests are
201200
running.
202201

203202
### Firebase Performance Monitoring
204-
If you're doing specific Firebase Performance Monitoring development, see
203+
204+
For specific Firebase Performance Monitoring development, see
205205
[the Performance README](FirebasePerformance/README.md) for instructions about building the SDK
206206
and [the Performance TestApp README](FirebasePerformance/Tests/TestApp/README.md) for instructions about
207207
integrating Performance with the dev test App.
@@ -214,10 +214,10 @@ To run the Storage Integration tests, follow the instructions in
214214
#### Push Notifications
215215

216216
Push notifications can only be delivered to specially provisioned App IDs in the developer portal.
217-
In order to actually test receiving push notifications, you will need to:
217+
In order to test receiving push notifications, you will need to:
218218

219219
1. Change the bundle identifier of the sample app to something you own in your Apple Developer
220-
account, and enable that App ID for push notifications.
220+
account and enable that App ID for push notifications.
221221
2. You'll also need to
222222
[upload your APNs Provider Authentication Key or certificate to the
223223
Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs)
@@ -226,9 +226,8 @@ at **Project Settings > Cloud Messaging > [Your Firebase App]**.
226226

227227
#### iOS Simulator
228228

229-
The iOS Simulator cannot register for remote notifications, and will not receive push notifications.
230-
In order to receive push notifications, you'll have to follow the steps above and run the app on a
231-
physical device.
229+
The iOS Simulator cannot register for remote notifications and will not receive push notifications.
230+
To receive push notifications, follow the steps above and run the app on a physical device.
232231

233232
## Building with Firebase on Apple platforms
234233

@@ -259,8 +258,8 @@ not recorded. (Crashes in SwiftUI are generated as mach exceptions, so will not
259258

260259
## Combine
261260
Thanks to contributions from the community, _FirebaseCombineSwift_ contains support for Apple's Combine
262-
framework. This module is currently under development, and not yet supported for use in production
263-
environments. Fore more details, please refer to the [docs](FirebaseCombineSwift/README.md).
261+
framework. This module is currently under development and not yet supported for use in production
262+
environments. For more details, please refer to the [docs](FirebaseCombineSwift/README.md).
264263

265264
## Roadmap
266265

0 commit comments

Comments
 (0)