An in-depth journey depicting all the ways to use Instabug Android SDK.

For more information about Instabug check our website.

Using Instabug is as easy as "Get ready, Get set, Go".

1. Determining which Instabug flavour to use (Getting ready)

   • If your minSdkVersion is 14+:

     Use instabug flavour

   • If your minSdkVersion is 10+:

     • If you're using Google support libraries (com.android.support:*):

       Use instabugcompat flavour

     • If you're using ActionBarSherlock:

       Use instabugabs flavour

2. Adding Instabug to your dependencies (Getting set)

   Grab your desired flavour via Gradle:

       compile 'com.instabug.library:instabug:2.3'

   or

       compile 'com.instabug.library:instabugcompat:2.3'

   or

       compile 'com.instabug.library:instabugabs:2.3'

   or via Maven: (if you're that kind of person )

       <dependency>
         <groupId>com.instabug.library</groupId>
         <artifactId>instabug</artifactId>
         <version>2.3</version>
       </dependency>

   or

       <dependency>
         <groupId>com.instabug.library</groupId>
         <artifactId>instabugcompat</artifactId>
         <version>2.3</version>
       </dependency>

   or

       <dependency>
         <groupId>com.instabug.library</groupId>
         <artifactId>instabugabs</artifactId>
         <version>2.3</version>
       </dependency>

3. Using Instabug (Good to go!)

   • Initializing Instabug:

     In your Application class add the following:

             @Override
             public void onCreate() {
                 super.onCreate();
                 // ...
                 new Instabug.Builder(this, "<YOUR_APP_TOKEN>")
                         .setInvocationEvent(IBGInvocationEvent.IBGInvocationEventFloatingButton)
                         .build();
                 // ...
             }
     

   • Extending Instabug Activities:

     ONLY if your minSdkVersion is 10+ should you extend Instabug*Activity

     • If you're using instabugcompat:
       • InstabugAppCompatActivity: extends android.support.v7.app.AppCompatActivity
       • InstabugActionBarActivity: extends android.support.v7.app.ActionBarActivity
       • InstabugActivity: extends android.app.activity
       • InstabugFragmentActivity: extends android.support.v4.app.FragmentActivity
       • InstabugExpandableListActivity: extends android.app.ExpandableListActivity
       • InstabugListActivity: extends android.app.ListActivity
       • InstabugPreferenceActivity: extends android.preference.PreferenceActivity
     • If you're using instabugabs:
       • InstabugSherlockActivity: extends com.actionbarsherlock.app.SherlockActivity
       • InstabugSherlockFragmentActivity: extends com.actionbarsherlock.app.SherlockFragmentActivity
       • InstabugSherlockExpandableListActivity: extends com.actionbarsherlock.app.SherlockExpandableListActivity
       • InstabugSherlockListActivity: extends com.actionbarsherlock.app.SherlockListActivity
       • InstabugSherlockPreferenceActivity: extends com.actionbarsherlock.app.SherlockPreferenceActivity

For technical documentation and FAQs check the wiki

Copyright 2012 Instabug, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.