Skip to content

Commit c2b77ba

Browse files
committed
update readme
1 parent 0e633f3 commit c2b77ba

File tree

1 file changed

+13
-27
lines changed

1 file changed

+13
-27
lines changed

README.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
# FirebaseUI for iOS — UI Bindings for Firebase
1+
# FirebaseUI for iOS — UI Bindings for Firebase [![Build Status](https://travis-ci.org/firebase/FirebaseUI-iOS.svg?branch=master)](https://travis-ci.org/firebase/FirebaseUI-iOS)
22

3-
[![Build Status](https://travis-ci.org/firebase/FirebaseUI-iOS.svg?branch=master)](https://travis-ci.org/firebase/FirebaseUI-iOS)
4-
5-
FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to the [Firebase](https://firebase.google.com?utm_campaign=Firebase_update_awareness_general_en_05-18-16_&utm_source=?utm_campaign=Firebase_featureoverview_awareness_analytics_en_05-18-16_&utm_source=?utm_campaign=Firebase_announcement_awareness_general_en_05-18-16_&utm_source=Firebase&utm_medium=ads&utm_medium=?utm_campaign=Firebase_announcement_awareness_general_en_05-18-16_&utm_source=Firebase&utm_medium=ads&utm_medium=?utm_campaign=Firebase_update_awareness_auth_en_05-18-16_&utm_source=?utm_campaign=Firebase_announcement_awareness_general_en_05-18-16_&utm_source=Firebase&utm_medium=ads&utm_medium=?utm_campaign=Firebase_featureoverview_awareness_analytics_en_05-18-16_&utm_source=?utm_campaign=Firebase_announcement_awareness_general_en_05-18-16_&utm_source=Firebase&utm_medium=ads&utm_medium=?utm_campaign=Firebase_announcement_awareness_general_en_05-18-16_&utm_source=Firebase&utm_medium=ads) 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.
3+
FirebaseUI is an open-source library for iOS that allows you to quickly connect common UI elements to the [Firebase](https://firebase.google.com) 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.
64

75
Additionally, FirebaseUI simplifies Firebase authentication by providing easy to use auth methods that integrate with common identity providers like Facebook, Twitter, and Google as well as allowing developers to use a built in headful UI for ease of development.
86

9-
A compatible FirebaseUI client is also available for [Android](https://github.com/firebase/FirebaseUI-Android).
7+
FirebaseUI clients are also available for [Android](https://github.com/firebase/FirebaseUI-Android) and [web](https://github.com/firebase/firebaseui-web).
108

119
## Installing FirebaseUI for iOS
1210

13-
FirebaseUI supports iOS 7.0+. We recommend using [CocoaPods](http://cocoapods.org/?q=firebaseui-ios), add
11+
FirebaseUI supports iOS 8.0+. We recommend using [CocoaPods](http://cocoapods.org/?q=firebaseui-ios), add
1412
the following to your `Podfile`:
1513

16-
```
14+
```ruby
1715
pod 'FirebaseUI', '~> 0.4' # Pull in all Firebase UI features
1816
```
1917

2018
If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:
2119

22-
```
20+
```ruby
2321
# Only pull in the "Database" FirebaseUI features
2422
pod 'FirebaseUI/Database', '~> 0.4'
2523

@@ -36,7 +34,7 @@ pod 'FirebaseUI/Google', '~> 0.4'
3634

3735
If you're including FirebaseUI in a Swift project, make sure you also have:
3836

39-
```
37+
```ruby
4038
platform :ios, '8.0'
4139
use_frameworks!
4240
```
@@ -57,18 +55,6 @@ $ cd FirebaseUI-iOS
5755
$ pod install
5856
```
5957

60-
FirebaseUI makes use of Xcode 7 features such as lightweight generics and
61-
`__kindof` annotations, and is no longer compatible with XCode 6 development.
62-
63-
## Deployment
64-
65-
- `git pull` to update the master branch
66-
- tag and push the tag for this release
67-
- `./build_database.sh` to build a database binary (Auth binary steps will be added soon)
68-
- `./create-docs.sh` to generate docs
69-
- From your macbook that already has been granted permissions to FirebaseUI CocoaPods, do `pod trunk push`
70-
- `firebase deploy` the FirebaseUI website with newly generated docs
71-
7258
## Contributing to FirebaseUI
7359

7460
### Contributor License Agreements
@@ -93,11 +79,11 @@ accept your pull requests.
9379
### Contribution Process
9480

9581
1. Submit an issue describing your proposed change to the repo in question.
96-
1. The repo owner will respond to your issue promptly.
97-
1. If your proposed change is accepted, and you haven't already done so, sign a
82+
2. The repo owner will respond to your issue promptly.
83+
3. If your proposed change is accepted, and you haven't already done so, sign a
9884
Contributor License Agreement (see details above).
99-
1. Fork the desired repo, develop and test your code changes.
100-
1. Ensure that your code adheres to the existing style of the library to which
85+
4. Fork the desired repo, develop and test your code changes.
86+
5. Ensure that your code adheres to the existing style of the library to which
10187
you are contributing.
102-
1. Ensure that your code has an appropriate set of unit tests which all pass.
103-
1. Submit a pull request and cc @davideast or @mcdonamp
88+
6. Ensure that your code has an appropriate set of unit tests which all pass.
89+
7. Submit a pull request

0 commit comments

Comments
 (0)