Skip to content

Commit f25a5bd

Browse files
SUPERCILEXsamtstern
authored andcommitted
Cleanup READMEs (#1013)
1 parent 7ca3cbf commit f25a5bd

File tree

3 files changed

+43
-39
lines changed

3 files changed

+43
-39
lines changed

README.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A compatible FirebaseUI client is also available for [iOS](https://github.com/fi
1818

1919
## Usage
2020

21-
FirebaseUI has separate modules for using Firebase Realtime Database, Cloud Firestore,
21+
FirebaseUI has separate modules for using Firebase Realtime Database, Cloud Firestore,
2222
Firebase Auth, and Cloud Storage. To get started, see the individual instructions for each module:
2323

2424
* [firebase-ui-database](database/README.md)
@@ -38,17 +38,17 @@ libraries.
3838

3939
```groovy
4040
dependencies {
41-
// FirebaseUI for Firebase Realtime Database
42-
compile 'com.firebaseui:firebase-ui-database:3.1.0'
43-
44-
// FirebaseUI for Cloud Firestore
45-
compile 'com.firebaseui:firebase-ui-firestore:3.1.0'
41+
// FirebaseUI for Firebase Realtime Database
42+
implementation 'com.firebaseui:firebase-ui-database:3.1.0'
4643
47-
// FirebaseUI for Firebase Auth
48-
compile 'com.firebaseui:firebase-ui-auth:3.1.0'
44+
// FirebaseUI for Cloud Firestore
45+
implementation 'com.firebaseui:firebase-ui-firestore:3.1.0'
4946
50-
// FirebaseUI for Cloud Storage
51-
compile 'com.firebaseui:firebase-ui-storage:3.1.0'
47+
// FirebaseUI for Firebase Auth
48+
implementation 'com.firebaseui:firebase-ui-auth:3.1.0'
49+
50+
// FirebaseUI for Cloud Storage
51+
implementation 'com.firebaseui:firebase-ui-storage:3.1.0'
5252
}
5353
```
5454

@@ -88,7 +88,8 @@ firebase-ui-storage
8888

8989
Each version of FirebaseUI has dependency on a fixed version of these libraries, defined as the variable `firebase_version`
9090
in `common/constants.gradle`. If you are using any dependencies in your app of the form
91-
`compile 'com.google.firebase:firebase-*:x.y.z'` or `compile 'com.google.android.gms:play-services-*:x.y.z'`
91+
`implementation 'com.google.firebase:firebase-*:x.y.z'` or
92+
`implementation 'com.google.android.gms:play-services-*:x.y.z'`
9293
you need to make sure that you use the same version that your chosen version of FirebaseUI requires.
9394

9495
For convenience, here are some recent examples:
@@ -112,59 +113,59 @@ For convenience, here are some recent examples:
112113

113114
If you would like to use a newer version of one of FirebaseUI's transitive dependencies, such
114115
as Firebase, Play services, or the Android support libraries, you need to add explicit
115-
`compile` declarations in your `build.gradle` for all of FirebaseUI's dependencies at the version
116+
`implementation` declarations in your `build.gradle` for all of FirebaseUI's dependencies at the version
116117
you want to use. For example if you want to use Play services/Firebase version `FOO` and support
117118
libraries version `BAR` add the following extra lines for each FirebaseUI module you're using:
118119

119120
Auth:
120121

121122
```groovy
122-
compile "com.google.firebase:firebase-auth:$FOO"
123-
compile "com.google.android.gms:play-services-auth:$FOO"
123+
implementation "com.google.firebase:firebase-auth:$FOO"
124+
implementation "com.google.android.gms:play-services-auth:$FOO"
124125
125-
compile "com.android.support:design:$BAR"
126-
compile "com.android.support:customtabs:$BAR"
127-
compile "com.android.support:cardview-v7:$BAR"
126+
implementation "com.android.support:design:$BAR"
127+
implementation "com.android.support:customtabs:$BAR"
128+
implementation "com.android.support:cardview-v7:$BAR"
128129
```
129130

130131
Realtime Database:
131132

132133
```groovy
133-
compile "com.google.firebase:firebase-database:$FOO"
134+
implementation "com.google.firebase:firebase-database:$FOO"
134135
135-
compile "com.android.support:recyclerview-v7:$BAR"
136-
compile "com.android.support:support-v4:$BAR"
136+
implementation "com.android.support:recyclerview-v7:$BAR"
137+
implementation "com.android.support:support-v4:$BAR"
137138
```
138139

139140
Firestore:
140141

141142
```groovy
142-
compile "com.google.firebase:firebase-firestore:$FOO"
143+
implementation "com.google.firebase:firebase-firestore:$FOO"
143144
144-
compile "com.android.support:recyclerview-v7:$BAR"
145-
compile "com.android.support:support-v4:$BAR"
145+
implementation "com.android.support:recyclerview-v7:$BAR"
146+
implementation "com.android.support:support-v4:$BAR"
146147
```
147148

148149
Storage:
149150

150151
```groovy
151-
compile "com.google.firebase:firebase-storage:$FOO"
152+
implementation "com.google.firebase:firebase-storage:$FOO"
152153
153-
compile "com.android.support:appcompat-v7:$BAR"
154-
compile "com.android.support:palette-v7:$BAR"
154+
implementation "com.android.support:appcompat-v7:$BAR"
155+
implementation "com.android.support:palette-v7:$BAR"
155156
```
156157

157158
NOTE :
158-
Starting version 25.4.0, support libraries are now available through [Google's Maven repository](https://developer.android.com/studio/build/dependencies.html#google-maven), so ensure that you have that added to your project's repositories.
159+
Starting version 25.4.0, support libraries are now available through
160+
[Google's Maven repository](https://developer.android.com/studio/build/dependencies.html#google-maven),
161+
so ensure that you have that added to your project's repositories.
159162

160163
Open the `build.gradle` file for your project and modify it as following,
161164

162165
```
163166
allprojects {
164167
repositories {
165-
maven {
166-
url "https://maven.google.com"
167-
}
168+
google()
168169
jcenter()
169170
}
170171
}

auth/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,16 @@ Gradle, add the dependency:
4545

4646
```groovy
4747
dependencies {
48-
// ...
49-
compile 'com.firebaseui:firebase-ui-auth:3.1.0'
48+
// ...
49+
implementation 'com.firebaseui:firebase-ui-auth:3.1.0'
5050
51-
// Required only if Facebook login support is required
52-
compile 'com.facebook.android:facebook-login:4.27.0'
51+
// Required only if Facebook login support is required
52+
// Find the latest Facebook SDK releases here: https://goo.gl/Ce5L94
53+
implementation 'com.facebook.android:facebook-login:4.x'
5354
54-
// Required only if Twitter login support is required
55-
compile("com.twitter.sdk.android:twitter-core:3.0.0@aar") { transitive = true }
55+
// Required only if Twitter login support is required
56+
// Find the latest Twitter SDK releases here: https://goo.gl/E5wZvQ
57+
implementation("com.twitter.sdk.android:twitter-core:3.x@aar") { transitive = true }
5658
}
5759
```
5860

@@ -472,7 +474,7 @@ to override certain or all styling attributes. For example, a green sign-in them
472474
<item name="colorPrimary">@color/material_green_500</item>
473475
<item name="colorPrimaryDark">@color/material_green_700</item>
474476
<item name="colorAccent">@color/material_purple_a700</item>
475-
477+
476478
<item name="colorControlNormal">@color/material_green_500</item>
477479
<item name="colorControlActivated">@color/material_lime_a700</item>
478480
<item name="colorControlHighlight">@color/material_green_a200</item>

storage/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ If you're not already using Glide in your application, add the following depende
1616
to your `app/build.gradle` file:
1717

1818
```groovy
19-
compile 'com.github.bumptech.glide:glide:4.1.1'
20-
annotationProcessor 'com.github.bumptech.glide:compiler:4.1.1'
19+
// Find the latest Glide releases here: https://goo.gl/LpksbR
20+
implementation 'com.github.bumptech.glide:glide:4.x'
21+
annotationProcessor 'com.github.bumptech.glide:compiler:4.x'
2122
```
2223

2324
To load an image from a `StorageReference`, first register an `AppGlideModule`:

0 commit comments

Comments
 (0)