You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-27Lines changed: 13 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,23 @@
1
-
# FirebaseUI for iOS — UI Bindings for Firebase
1
+
# FirebaseUI for iOS — UI Bindings for Firebase[](https://travis-ci.org/firebase/FirebaseUI-iOS)
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.
6
4
7
5
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.
8
6
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).
10
8
11
9
## Installing FirebaseUI for iOS
12
10
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
14
12
the following to your `Podfile`:
15
13
16
-
```
14
+
```ruby
17
15
pod 'FirebaseUI', '~> 0.4'# Pull in all Firebase UI features
18
16
```
19
17
20
18
If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:
21
19
22
-
```
20
+
```ruby
23
21
# Only pull in the "Database" FirebaseUI features
24
22
pod 'FirebaseUI/Database', '~> 0.4'
25
23
@@ -36,7 +34,7 @@ pod 'FirebaseUI/Google', '~> 0.4'
36
34
37
35
If you're including FirebaseUI in a Swift project, make sure you also have:
38
36
39
-
```
37
+
```ruby
40
38
platform :ios, '8.0'
41
39
use_frameworks!
42
40
```
@@ -57,18 +55,6 @@ $ cd FirebaseUI-iOS
57
55
$ pod install
58
56
```
59
57
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
-
72
58
## Contributing to FirebaseUI
73
59
74
60
### Contributor License Agreements
@@ -93,11 +79,11 @@ accept your pull requests.
93
79
### Contribution Process
94
80
95
81
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
98
84
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
101
87
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.
0 commit comments