Skip to content

Commit f5285e5

Browse files
Update README.md (#151)
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 417cb42 commit f5285e5

File tree

1 file changed

+7
-61
lines changed

1 file changed

+7
-61
lines changed

README.md

Lines changed: 7 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -22,67 +22,15 @@ ionic cordova plugin add instabug-cordova
2222

2323
## Integration Steps
2424

25-
### instabug-cordova >= 10.0.0
26-
27-
Add the following snippet to your `index.js` file inside `onDeviceReady` function:
28-
> Don't forget to replace `YOUR_CORDOVA_TOKEN` with your token.
25+
- Add the following snippet to your `index.js` file inside `onDeviceReady` function:
2926

3027
```js
31-
var Instabug = cordova.require("instabug-cordova.Instabug");
32-
var BugReporting = cordova.require("instabug-cordova.BugReporting");
28+
var Instabug = cordova.require('instabug-cordova.Instabug');
29+
var BugReporting = cordova.require('instabug-cordova.BugReporting');
3330

3431
Instabug.start(
35-
"YOUR_CORDOVA_TOKEN",
32+
'YOUR_CORDOVA_TOKEN',
3633
[BugReporting.invocationEvents.button],
37-
() => console.log("Instabug initialized."),
38-
(error) => console.log("Instabug could not be initialized - " + error)
39-
);
40-
```
41-
42-
### instabug-cordova <= 9.1.7
43-
44-
#### Android
45-
46-
1. Change the name of the application class in your AndroidManifest.xml file to `android:name="com.instabug.cordova.plugin.MyApplication"`.
47-
48-
2. You need to add your app token in the **MyApplication** class, by replacing `YOUR_ANDROID_TOKEN`. (You can find this class under this path `YourProjectName/platforms/android/app/src/main/java/com.instabug.cordova.plugin/MyApplication.java`)
49-
50-
3. You can change the invocation event by changing this line `InstabugInvocationEvent.SHAKE` in the **MyApplication** class to any of the following:
51-
52-
`InstabugInvocationEvent.FLOATING_BUTTON`, `InstabugInvocationEvent.SCREENSHOT_GESTURE`, `InstabugInvocationEvent.TWO_FINGER_SWIPE_LEFT`, or `InstabugInvocationEvent.NONE`.
53-
54-
4. Make sure the following snippet is added to your project level `build.gradle`, if not you can manually add it as follows:.
55-
56-
```dart
57-
allprojects {
58-
repositories {
59-
maven {
60-
url "https://sdks.instabug.com/nexus/repository/instabug-cp"
61-
}
62-
}
63-
}
64-
```
65-
66-
⚠️ Starting from Instabug-Cordova v9, we require the `compileSdkVersion` to be set to a minimum of `29`. It can be set inside the app's `build.gradle` file as below:
67-
68-
android {
69-
compileSdkVersion 29
70-
}
71-
72-
#### iOS
73-
74-
You can initialize the SDK by using this method in your App JS file.
75-
76-
```
77-
cordova.plugins.instabug.activate(
78-
{
79-
ios: 'MY_IOS_TOKEN'
80-
},
81-
'shake',
82-
{
83-
commentRequired: true,
84-
colorTheme: 'light'
85-
},
8634
function () {
8735
console.log('Instabug initialized.');
8836
},
@@ -92,11 +40,9 @@ cordova.plugins.instabug.activate(
9240
);
9341
```
9442

95-
You can change the invocation event with any of the following: `'button'`, `'screenshot'`, `'swipe'`, or `'shake'`.
96-
97-
⚠️ TypeScript users, make sure you declare `cordova` at the beginning of your app class (app.component.ts):
43+
- Replace `YOUR_CORDOVA_TOKEN` with your application token.
9844

99-
declare let cordova: any;
45+
> :warning: If you're updating the SDK from versions prior to v11, please check our [migration guide](https://docs.instabug.com/docs/cordova-migration-guide).
10046
10147
## Features Not Yet Supported
10248
- User steps.
@@ -110,4 +56,4 @@ You can change the invocation event with any of the following: `'button'`, `'scr
11056

11157
This software is released under the <a href="http://opensource.org/licenses/Apache-2.0">Apache 2.0 License</a>.
11258

113-
© 2016 Instabug. All rights reserved.
59+
© 2022 Instabug. All rights reserved.

0 commit comments

Comments
 (0)