|
1 | | -# Instabug Cordova Plugin |
| 1 | +# Deprecation of Cordova Support |
| 2 | +Support for Cordova will officially end on June 30, 2025. As Cordova's adoption has steadily declined and modern alternatives like Flutter and React Native have become the preferred choices for cross-platform development, we are deprecating our support to focus on platforms that align with current developer needs. |
2 | 3 |
|
3 | | -The purpose of this plugin is to simplify the process of integrating the Instabug SDK in a hybrid application, as well as to provide an interface to interact with the SDK through JavaScript. |
| 4 | +# Extended Support |
| 5 | +We understand this transition may impact some of our users and are committed to assisting you. If you require extended support for Xamarin, Cordova, or Unity beyond the deprecation date, please reach out to our team. |
4 | 6 |
|
5 | | -Instabug is a bug reporting and in-app feedback tool that provides your testers and users with easy “shake to send” feedback from within the app, to [report bugs and issues easily](https://instabug.com/bug-reporting). You’ll get attached screenshots, screen recordings, annotations, network logs to help you take insightful decisions. You’ll also receive all the device details, environment snapshots and bug reproduction steps so that you can fix bugs and iterate faster. |
| 7 | +## Documentation |
| 8 | +For more details about the supported APIs and how to use them, you can refer to our [docs](https://docs.instabug.com/docs/cordova-overview "**docs**"). |
6 | 9 |
|
7 | | -For more info, visit [Instabug.com](https://instabug.com). |
| 10 | +## Contact Us |
8 | 11 |
|
9 | | -## Installation |
10 | | - |
11 | | -### Cordova: |
12 | | - |
13 | | -``` |
14 | | -cordova plugin add instabug-cordova |
15 | | -``` |
16 | | - |
17 | | -### Ionic: |
18 | | - |
19 | | -``` |
20 | | -ionic cordova plugin add instabug-cordova |
21 | | -``` |
22 | | - |
23 | | -## Integration Steps |
24 | | - |
25 | | -- Add the following snippet to your `index.js` file inside `onDeviceReady` function: |
26 | | - |
27 | | -```js |
28 | | -var Instabug = cordova.require('instabug-cordova.Instabug'); |
29 | | -var BugReporting = cordova.require('instabug-cordova.BugReporting'); |
30 | | - |
31 | | -Instabug.start( |
32 | | - 'YOUR_CORDOVA_TOKEN', |
33 | | - [BugReporting.invocationEvents.button], |
34 | | - function () { |
35 | | - console.log('Instabug initialized.'); |
36 | | - }, |
37 | | - function (error) { |
38 | | - console.log('Instabug could not be initialized - ' + error); |
39 | | - } |
40 | | -); |
41 | | -``` |
42 | | - |
43 | | -- Replace `YOUR_CORDOVA_TOKEN` with your application token. |
44 | | - |
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). |
46 | | -
|
47 | | -## Features Not Yet Supported |
48 | | -- User steps. |
49 | | -- Repro steps. |
50 | | -- Network logging. |
51 | | -- View hierarchy. |
52 | | -- Crash reporting. |
53 | | -- Push notification for in-app messaging. |
54 | | - |
55 | | -## License |
56 | | - |
57 | | -This software is released under the <a href="http://opensource.org/licenses/Apache-2.0">Apache 2.0 License</a>. |
58 | | - |
59 | | -© 2022 Instabug. All rights reserved. |
| 12 | +If you have any questions or feedback, don’t hesitate to get in touch. You can reach out to us at any time through [[email protected]](mailto:[email protected]). |
0 commit comments