Skip to content

Commit 3ed520e

Browse files
committed
- update readme
1 parent d50b491 commit 3ed520e

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,81 @@
11
# SimpleFirebaseAnalytics
2+
Simplified send firebase event for Android.
3+
4+
[![](https://jitpack.io/v/kshdreams/SimpleFirebaseAnalytics.svg)](https://jitpack.io/#kshdreams/SimpleFirebaseAnalytics)
5+
6+
##### GETTING STARTED
7+
SimpleFirebaseAnalytics releases are available via JitPack.
8+
```ruby
9+
// Project level build.gradle
10+
// ...
11+
repositories {
12+
maven { url 'https://jitpack.io' }
13+
}
14+
// ...
15+
16+
// Module level build.gradle
17+
dependencies {
18+
// Replace version with release version, e.g. 1.0.0-alpha, -SNAPSHOT
19+
implementation "com.github.kshdreams:SimpleFirebaseAnalytics:[VERSION]"
20+
}
21+
```
22+
23+
24+
###### USAGE
25+
call SimpleFirebaseAnalytics.init() method on your Application.onCreate() method
26+
```Java
27+
public class YourApplication extends Application {
28+
29+
@Override
30+
public void onCreate() {
31+
super.onCreate();
32+
33+
SimpleFirebaseAnalytics.init(this, new Analytics() {
34+
@Override
35+
public boolean isUserAgreed() {
36+
// TODO : better to show dialog to agree to send event log
37+
return true;
38+
}
39+
40+
@Override
41+
public void setCurrentScreen(Activity activity, String var1, String var2) {
42+
FirebaseAnalytics.getInstance(activity).setCurrentScreen(activity, var1, var2);
43+
}
44+
45+
@Override
46+
public void logEvent(String event, Bundle param) {
47+
FirebaseAnalytics.getInstance(FirebaseApplication.this).logEvent(event, param);
48+
}
49+
});
50+
```
51+
52+
just define @FirebaseScreen annotation to Activity, Fragment class instead of call FirebaseAnalytics.setCurrentScreen()
53+
54+
```Java
55+
@FirebaseScreen("main_screen")
56+
public class MainActivity extends AppCompatActivity {
57+
}
58+
59+
@FirebaseScreen("main_fragment")
60+
public class MainFragment extends Fragmet {
61+
}
62+
```
63+
64+
65+
just define @FirebaseEvent, @FirebaseParam on your data(pojo) class,
66+
```Java
67+
@FirebaseEvent("click_event")
68+
public class ClickEvent {
69+
70+
@FirebaseParam("view")
71+
public String view;
72+
73+
@FirebaseParam("extra")
74+
public String extra;
75+
```
76+
77+
and send firebase event using object.
78+
```Java
79+
SimpleFirebaseAnalytics.sendEvent(ClickEvent.create("snackbar", "some extra here"));
80+
```
81+

0 commit comments

Comments
 (0)