Skip to content

Commit 6978c94

Browse files
committed
Small changes to the README, shuffling around contribution instructions, adding the correct cocoapods version.
1 parent 4dbdfcf commit 6978c94

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FirebaseUI for iOS — UI Bindings for Firebase
22

3-
FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to the Firebase [Firebase](https://www.firebase.com/?utm_source=firebaseui-ios) database to apps for data storage, allowing views to be updated in realtime as they change, and providing simple interfaces for common tasks.
3+
FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to the Firebase [Firebase](https://www.firebase.com/?utm_source=firebaseui-ios) database for data storage, allowing views to be updated in realtime as they change, and providing simple interfaces for common tasks like displaying lists or collections of items.
44

55
A compatible FirebaseUI client is also available for [Android](https://github.com/firebase/FirebaseUI-Android).
66

@@ -10,16 +10,13 @@ We recommend using [CocoaPods](http://cocoapods.org/?q=firebaseui-ios), add
1010
the following to your `Podfile`:
1111

1212
```
13-
pod 'FirebaseUI', '>= 0.1'
13+
pod 'FirebaseUI', '>= 0.1.0'
1414
```
1515

16-
Otherwise, you need to download the framework and
17-
add it to your project. You also need to [add the Firebase
18-
framework](https://www.firebase.com/docs/ios-quickstart.html?utm_source=firebaseui-ios) to your project.
19-
20-
You can download the latest version of the [FirebaseUI.framework from the releases
16+
Otherwise, you can download the latest version of the [FirebaseUI.framework from the releases
2117
page](https://github.com/firebase/FirebaseUI-iOS/releases) or include the FirebaseUI
22-
Xcode project from this repo in your project.
18+
Xcode project from this repo in your project. You also need to [add the Firebase
19+
framework](https://www.firebase.com/docs/ios-quickstart.html?utm_source=firebaseui-ios) to your project.
2320

2421
### Using FirebaseUI with Swift
2522

@@ -36,7 +33,6 @@ to your project. To do that, [follow these instructions](https://www.firebase.co
3633
FirebaseUI requires Firebase in order to store location data. You can [sign up here for a free
3734
account](https://www.firebase.com/signup/?utm_source=firebaseui-ios).
3835

39-
4036
## FirebaseUI for iOS Quickstart
4137

4238
This is a quickstart on how to use FirebaseUI's core features to speed up iOS development with Firebase.
@@ -56,7 +52,7 @@ MyViewController.h
5652
```objective-c
5753
MyViewController.m
5854
...
59-
self.firebaseRef = [[Firebase alloc] initWithUrl:@"https://<your-firebase>.firebaseio.com/"];
55+
self.firebaseRef = [[Firebase alloc] initWithUrl:@"https://<your-firebase-app>.firebaseio.com/"];
6056
self.dataSource = [[FirebaseTableViewDataSource alloc] initWithRef:firebaseRef reuseIdentifier:@"<your-reuse-identifier>" view:self.tableView];
6157

6258
[self.dataSource populateCellWithBlock:^(UITableViewCell *cell, FDataSnapshot *snap) {
@@ -145,22 +141,14 @@ FirebaseArray is synchronized array connecting a Firebase Ref with an array. It
145141
146142
##### Objective-C
147143
```objective-c
148-
FirebaseArray *array = [[FirebaseArray alloc] initWithRef:@"https://<your-firebase>.firebaseio.com/"];
144+
FirebaseArray *array = [[FirebaseArray alloc] initWithRef:@"https://<your-firebase-app>.firebaseio.com/"];
149145
150146
```
151147

152148
### FirebaseDataSource
153149

154150
FirebaseDataSource acts as a generic data source by providing common information, such as the count of objects in the data source, and by requiring subclasses to implement FirebaseArrayDelegate methods as appropriate to the view. This class should never be instantiated, but should be subclassed when creating a specific adapter for a View. [FirebaseTableViewDataSource](https://github.com/firebase/FirebaseUI-iOS/blob/master/FirebaseUI/Implementation/FirebaseTableViewDataSource.m) is an example of this.
155151

156-
## Deployment
157-
158-
- `git pull` to update the master branch
159-
- tag and push the tag for this release
160-
- `./build.sh` to build a binary
161-
- From your macbook that already has been granted permissions to Firebase Cocoapods, do `pod trunk push`
162-
- Update [firebase-versions](https://github.com/firebase/firebase-clients/blob/master/versions/firebase-versions.json) with the changelog for this release.
163-
164152
## Local Setup
165153

166154
If you'd like to contribute to FirebaseUI for iOS, you'll need to run the
@@ -172,7 +160,17 @@ $ cd FirebaseUI-iOS
172160
$ ./setup.sh
173161
```
174162

175-
## Contributor License Agreements
163+
## Deployment
164+
165+
- `git pull` to update the master branch
166+
- tag and push the tag for this release
167+
- `./build.sh` to build a binary
168+
- From your macbook that already has been granted permissions to FirebaseUI Cocoapods, do `pod trunk push`
169+
- Update [firebase-versions](https://github.com/firebase/firebase-clients/blob/master/versions/firebase-versions.json) with the changelog for this release.
170+
171+
## Contributing to FirebaseUI
172+
173+
### Contributor License Agreements
176174

177175
We'd love to accept your sample apps and patches! Before we can take them, we
178176
have to jump a couple of legal hurdles.
@@ -191,7 +189,7 @@ Follow either of the two links above to access the appropriate CLA and
191189
instructions for how to sign and return it. Once we receive it, we'll be able to
192190
accept your pull requests.
193191

194-
## Contributing A Patch
192+
### Contribution Process
195193

196194
1. Submit an issue describing your proposed change to the repo in question.
197195
1. The repo owner will respond to your issue promptly.

0 commit comments

Comments
 (0)