bugbattle
Version:
62 lines (40 loc) • 1.85 kB
Markdown
# Bugbattle JavaScript SDK
The Bugbattle SDK for JavScript is the easiest way to integrate Bugbattle into your apps! Achieve better app quality & ratings with comprehensive in-app bug reporting. BugBattle offers affordable In-App Bug Reporting for Apps, WebApps & Websites.
## 📖 Docs & Examples
Checkout our [documentation](https://docs.bugbattle.io/docs/javascript-sdk) for full reference.
## ❤️ Demo
[https://jssdk.bugbattle.io/demo](https://jssdk.bugbattle.io/demo)
## ⭐️ Features
- Plain and instant setup
- Enhance your apps with bug reporting
- Easy integration
- Datacenter in europe
- Automatic crash detection
- Multiple platforms (iOS, Android, JavaScript)
## 🚀 Getting started
1.) Register an account at [www.bugbattle.io](https://www.bugbattle.io). It's free and takes just a few seconds.
2.) Include the BugBattle JS SDK within your apps.
### Installation via nom
Install the **bugbattle** package via npm or yarn.
```
npm install bugbattle --save
```
Import the **bugbattle** package.
```
import BugBattle from 'bugbattle';
```
### Manual installation
Add the following lines to your website's / webapp's ```<head>```-tag:
```
<script src="https://jssdk.bugbattle.io/latest/index.js"></script>
<script>let BugBattle = window.BugBattle.default;</script>
```
### Initialize the SDK
Add the following code to to initialize the BugBattle JavaScript SDK. Replace "YOUR-SDK-TOKEN-HERE" with your actual SDK token from the [Bugbattle dashboard](https://app.bugbattle.io).
```
BugBattle.initialize("YOUR-SDK-TOKEN-HERE", BugBattle.FEEDBACK_BUTTON);
```
Congrats, you are now all set! Report your first bug by using the feedback button.
## 🤝 Need help?
We are here to help! hello@bugbattle.io