@@ -5,41 +5,97 @@ An in-depth journey depicting all the ways to use [Instabug Android SDK][1].
5
5
6
6
For more information about Instabug check [ our website] [ 2 ] .
7
7
8
-
9
8
Usage
10
9
--------
11
- It's as easy as "Get ready, Get set, Go".
10
+ Using Instabug is as easy as "Get ready, Get set, Go".
11
+
12
+ 1 . <b >Determining which Instabug flavour to use</b > (Getting ready)
13
+ * If your ` minSdkVersion ` is ` 14+ ` :
14
+
15
+ Use ` instabug ` flavour
16
+
17
+ * If your ` minSdkVersion ` is ` 10+ ` :
18
+
19
+ * If you're using Google support libraries (` com.android.support:* ` ):
20
+
21
+ Use ` instabugcompat ` flavour
22
+
23
+ * If you're using [ ActionBarSherlock] ( https://github.com/JakeWharton/ActionBarSherlock ) :
24
+
25
+ Use ` instabugabs ` flavour
12
26
13
- 1 . <b >Adding Instabug to your dependencies</b > (Getting ready )
27
+ 1 . <b >Adding Instabug to your dependencies</b > (Getting set )
14
28
15
- Grab it via Gradle:
29
+ Grab your desired flavour via Gradle:
30
+ ``` groovy
31
+ compile 'com.instabug.library:instabug:2.0'
32
+ ```
33
+ or
34
+ ```groovy
35
+ compile 'com.instabug.library:instabugcompat:2.0'
36
+ ```
37
+ or
16
38
```groovy
17
- compile 'com.instabug.library:instabugcompat :2.0-SNAPSHOT '
39
+ compile 'com.instabug.library:instabugabs :2.0'
18
40
```
19
41
or via Maven: (if you're that kind of person :bowtie:)
20
42
```xml
21
- <dependency>
22
- <groupId>com.instabug.library</groupId>
23
- <artifactId>instabugcompat </artifactId>
24
- <version>2.0-SNAPSHOT </version>
25
- </dependency>
43
+ <dependency>
44
+ <groupId>com.instabug.library</groupId>
45
+ <artifactId>instabug </artifactId>
46
+ <version>2.0</version>
47
+ </dependency>
26
48
```
27
-
28
- 1. <b>Initialising Instabug</b> (Getting set)
29
-
30
- In your `Application` class add the following:
49
+ or
50
+ ```xml
51
+ <dependency>
52
+ <groupId>com.instabug.library</groupId>
53
+ <artifactId>instabugcompat</artifactId>
54
+ <version>2.0</version>
55
+ </dependency>
31
56
```
32
- @Override
33
- public void onCreate() {
34
- super.onCreate();
35
- // ...
36
- new Instabug.Builder(this, "<yourAppToken>")
37
- .build();
38
- // ...
39
- }
57
+ or
58
+ ```xml
59
+ <dependency>
60
+ <groupId>com.instabug.library</groupId>
61
+ <artifactId>instabugabs</artifactId>
62
+ <version>2.0</version>
63
+ </dependency>
40
64
```
41
65
42
- 1. <b>Go!</b>
66
+ 1. <b>Using Instabug</b> (Good to go!)
67
+
68
+ * Initializing Instabug:
69
+
70
+ In your `Application` class add the following:
71
+ ```
72
+ @Override
73
+ public void onCreate() {
74
+ super.onCreate();
75
+ // ...
76
+ new Instabug.Builder(this, "<YOUR_APP_TOKEN>")
77
+ .setInvocationEvent(IBGInvocationEvent.IBGInvocationEventFloatingButton)
78
+ .build();
79
+ // ...
80
+ }
81
+ ```
82
+ * Extending Instabug Activities:
83
+
84
+ **ONLY** if your `minSdkVersion` is **`10+`** should you extend `Instabug*Activity`
85
+ * If you're using `instabugcompat`:
86
+ * `InstabugAppCompatActivity`: extends `android.support.v7.app.AppCompatActivity`
87
+ * `InstabugActionBarActivity`: extends `android.support.v7.app.ActionBarActivity`
88
+ * `InstabugActivity`: extends `android.app.activity`
89
+ * `InstabugFragmentActivity`: extends `android.support.v4.app.FragmentActivity`
90
+ * `InstabugExpandableListActivity`: extends `android.app.ExpandableListActivity`
91
+ * `InstabugListActivity`: extends `android.app.ListActivity`
92
+ * `InstabugPreferenceActivity`: extends `android.preference.PreferenceActivity`
93
+ * If you're using `instabugabs`:
94
+ * `InstabugSherlockActivity`: extends `com.actionbarsherlock.app.SherlockActivity`
95
+ * `InstabugSherlockFragmentActivity`: extends `com.actionbarsherlock.app.SherlockFragmentActivity`
96
+ * `InstabugSherlockExpandableListActivity`: extends `com.actionbarsherlock.app.SherlockExpandableListActivity`
97
+ * `InstabugSherlockListActivity`: extends `com.actionbarsherlock.app.SherlockListActivity`
98
+ * `InstabugSherlockPreferenceActivity`: extends `com.actionbarsherlock.app.SherlockPreferenceActivity`
43
99
44
100
For technical documentation and FAQs check the [wiki][wiki]
45
101
0 commit comments