v3.0.3

GleapSDK · Nov 13, 2020 · 42374cb · 42374cb
1 parent 4e75382
commit 42374cb
Show file tree

Hide file tree

Showing 32 changed files with 73 additions and 96 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
-## BugBattle JavaScript SDK
-Achieve better app quality & ratings with comprehensive in-app bug reporting. BugBattle offers affordable In-App Bug Reporting for Apps, WebApps & Websites.
+# Bugbattle iOS SDK
+
+![Bugbattle JavaScript SDK Intro](https://github.com/BugBattle/JavaScript-SDK/blob/master/imgs/JavaScriptSDK.png)
+
+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
 
@@ -20,49 +27,65 @@ Achieve better app quality & ratings with comprehensive in-app bug reporting. Bu
 
 2.) Include the BugBattle JS SDK within your apps.
 
-NPM / YARN:
+### Installation via nom
+
+Install the **bugbattle** package via npm or yarn.
 ```
 npm install bugbattle --save
 ```
 
-OR add the following lines to your website's / webapp's head-tag:
+Import the **bugbattle** package.
+```
+import BugBattle from 'bugbattle';
+```
+
+### Manual installation
+
+Add the following lines to your website's / webapp's ```<head>```-tag:
 ```
 <link href="https://jssdk.bugbattle.io/latest/index.css" rel="stylesheet">
 <script src="https://jssdk.bugbattle.io/latest/index.js"></script>
 <script>let BugBattle = window.BugBattle.default;</script>
 ```
 
-3.) Initialize the SDK
+### Initialize the SDK
 
-Add the following code to your app / website to initialize the BugBattle JavaScript SDK. Replace "YOUR-SDK-TOKEN-HERE" with your actual sdk token.
+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).
 
 ```
-<script>
 BugBattle.initialize("YOUR-SDK-TOKEN-HERE", BugBattle.FEEDBACK_BUTTON);
-</script>
 ```
 
 Congrats, you are now all set! Report your first bug by using the feedback button.
 
-## 🤤 Customization / tracking more data
+## 🤤 Customization
 
 You can track more data (i.e. the app build number, version code or custom data) by using one of the following functions.
 
 ```
-// Set's the main color (color schema).
+// Sets the main color (color schema).
 BugBattle.setMainColor("#086EFB");
 
-// Set's the app's build number.
+// Sets the app's build number.
 BugBattle.setAppBuildNumber(5);
 
-// Set's the app's version code.
+// Sets the app's version code.
 BugBattle.setAppVersionCode("v5.0");
 
 // Attaches custom data to the bug reports.
 BugBattle.setCustomData({
     test1: "Battle",
     data2: "Unicorn"
 });
+
+// Enables the privacy policy check.
+BugBattle.enablePrivacyPolicy(true);
+
+// Sets the privacy policy.
+BugBattle.setPrivacyPolicyUrl("https://someawesomesite...");
+
+// Enables the automatic detection of crashes.
+BugBattle.enableCrashDetector(true);
 ```
 
 ## 🤠 Activation methods

diff --git a/build/index.css b/build/index.css
diff --git a/build/index.css.map b/build/index.css.map
diff --git a/build/index.js b/build/index.js
diff --git a/build/index.js.map b/build/index.js.map
diff --git a/demo/.DS_Store b/demo/.DS_Store
diff --git a/demo/bugbattlelogo.png b/demo/bugbattlelogo.png