Skip to content

Commit 7567f4b

Browse files
committed
Document how to add dependency
1 parent 07f95c1 commit 7567f4b

File tree

5 files changed

+38
-0
lines changed

5 files changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
11
# FirebaseUI-Android
2+
3+
This library provides the simplest way to bind the Firebase Android SDK to your native Android app.
4+
Get started now, be running in minutes.
5+
6+
## Using the library in your Android app
7+
8+
To use the FirebaseUI library in our project, we need to do a few things:
9+
10+
1. Add the library to the list of dependencies of our project
11+
2. Create a class to represent the properties of our objects, as they are stored into the database
12+
3. Create a custom list adapter to map from Firebase to Android
13+
14+
The FirebaseUI library is most prominent in step 3. But first we have to add it to our project.
15+
16+
### Adding the library to your project (gradle.build or module dependencies dialog)
17+
18+
If your Android app already uses Firebase, you have added a dependency to the Firebase SDK to your dependencies.
19+
In this step we'll add the FirebaseUI library as another dependency.
20+
21+
![Open module settings](doc-images/1-module-settings-menu.png "Open the module settings")
22+
![Current dependencies](doc-images/2-module-settings-add-library.png "Current dependencies")
23+
![Find library](doc-images/3-module-settings-find-library.png "Find the firebase-ui library")
24+
![Updated dependencies](doc-images/4-module-settings-library-added.png "Updated dependencies")
25+
26+
You can also add the library dependency directly to your app's gradle.build file:
27+
28+
![Added to gradle.build](doc-images/5-gradle-dependency-added.png "Added to gradle.build")
29+
30+
After the project is synchronized, we're ready to start using Firebase functionality in our app.
31+
32+
### Creating a model class
33+
34+
35+
36+
### Subclassing the FirebaseListAdapter
37+
38+
39+
## Contributing to the library

doc-images/1-module-settings-menu.png

113 KB
Loading
66.4 KB
Loading
Loading
144 KB
Loading

0 commit comments

Comments
 (0)