@@ -10,11 +10,21 @@ A compatible FirebaseUI client is also available for [iOS](https://github.com/fi
10
10
11
11
## Table of Contents
12
12
13
- 1 . [ Installation] ( #installation )
14
13
1 . [ Usage] ( #usage )
14
+ 1 . [ Installation] ( #installation )
15
+ 1 . [ Dependencies] ( #dependencies )
15
16
1 . [ Sample App] ( #sample-app )
16
17
1 . [ Contributing] ( #contributing )
17
18
19
+ ## Usage
20
+
21
+ FirebaseUI has separate modules for using Firebase Database, Auth, and Storage. To
22
+ get started, see the individual instructions for each module:
23
+
24
+ * [ firebase-ui-database] ( database/README.md )
25
+ * [ firebase-ui-auth] ( auth/README.md )
26
+ * [ firebase-ui-storage] ( storage/README.md )
27
+
18
28
## Installation
19
29
20
30
FirebaseUI is published as a collection of libraries separated by the
@@ -47,6 +57,8 @@ required.
47
57
48
58
After the project is synchronized, we're ready to start using Firebase functionality in our app.
49
59
60
+ ## Dependencies
61
+
50
62
### Compatibility with Firebase / Google Play Services Libraries
51
63
52
64
FirebaseUI libraries have the following transitive dependencies on the Firebase SDK:
@@ -67,29 +79,52 @@ in `common/constants.gradle`. If you are using any dependencies in your app of
67
79
` compile 'com.google.firebase:firebase-*:x.y.z' ` or ` compile 'com.google.android.gms:play-services-*:x.y.z' `
68
80
you need to make sure that you use the same version that your chosen version of FirebaseUI requires.
69
81
70
- For convenience, here are some examples:
82
+ For convenience, here are some recent examples:
71
83
72
84
| FirebaseUI Version | Firebase/Play Services Version |
73
85
| --------------------| --------------------------------|
74
86
| 1.2.0 | 10.2.0 |
75
87
| 1.1.1 | 10.0.0 or 10.0.1 |
76
88
| 1.0.1 | 10.0.0 or 10.0.1 |
77
89
| 1.0.0 | 9.8.0 |
78
- | 0.6.2 | 9.8.0 |
79
- | 0.6.1 | 9.6.1 |
80
- | 0.6.0 | 9.6.0 |
81
- | 0.5.3 | 9.4.0 |
82
- | 0.4.4 | 9.4.0 |
83
- | 0.4.3 | 9.2.1 |
84
- | 0.4.2 | 9.2.0 |
85
- | 0.4.1 | 9.0.2 |
86
- | 0.4.0 | 9.0.0 |
87
90
88
- ## Usage
89
91
90
- * [ firebase-ui-database] ( database/README.md )
91
- * [ firebase-ui-auth] ( auth/README.md )
92
- * [ firebase-ui-storage] ( storage/README.md )
92
+ ## Upgrading dependencies
93
+
94
+ If you would like to use a newer version of one of FirebaseUI's transitive dependencies, such
95
+ as Firebase, Play services, or the Android support libraries you need add explicit
96
+ ` compile ` declarations in your ` build.gradle ` for all of FirebaseUI's dependencies at the version
97
+ you want to use. For example if you want to use Play services/Firebase version ` FOO ` and support
98
+ libraries version ` BAR ` add the following extra lines for each FirebaseUI module you're using:
99
+
100
+ Auth:
101
+
102
+ ``` groovy
103
+ compile "com.google.firebase:firebase-auth:$FOO"
104
+ compile "com.google.android.gms:play-services-auth:$FOO"
105
+
106
+ compile "com.android.support:design:$BAR"
107
+ compile "com.android.support:customtabs:$BAR"
108
+ compile "com.android.support:cardview-v7:$BAR"
109
+ ```
110
+
111
+ Database:
112
+
113
+ ``` groovy
114
+ compile "com.google.firebase:firebase-database:$FOO"
115
+
116
+ compile "com.android.support:recyclerview-v7:$BAR"
117
+ compile "com.android.support:support-v4:$BAR"
118
+ ```
119
+
120
+ Storage:
121
+
122
+ ``` groovy
123
+ compile "com.google.firebase:firebase-storage:$FOO"
124
+
125
+ compile "com.android.support:appcompat-v7:$BAR"
126
+ compile "com.android.support:palette-v7:$BAR"
127
+ ```
93
128
94
129
## Sample App
95
130
0 commit comments