update the sdk to version 1.1.1-beta

migaber · migaber · commit f89f638c3983 · 2017-05-02T00:12:42.000+03:00
diff --git a/README.md b/README.md
@@ -1,23 +1,40 @@
-# Instabug web SDK
+# Instabug web SDK 1.1.1-beta
 
-Instabug web sdk is a javascript library to add ability to report bugs from your website and report it to Instabug dashboard.
+## Overview
+Instabug web sdk is a javascript library provides an easy way to report bugs from your website or webapp.
 
-### Install Instabug
-to include instabug web sdk to your website just copy the below lines into the end of your page `<body>` tag
+To use the sdk you need to have `application_token`, you  can get it from your [Instabug Dashboard](https://dashboard.instabug.com)
+
+## Installation
+### Requirements
+Instabug Web SDK requires no special requirements, and has no dependecies on other liberaries or frameworks, and has been tested in all modern browsers with `LocalStorage` capability
+
+#### Manual Installation
+You can include instabug web sdk to your website just copy the below lines into the end of your page `<body>` tag
 ```html
 <script src='https://s3.amazonaws.com/instabug-pro/sdk_releases/instabugsdk-1.1.1.min.js'></script>
+```
+#### `bower` installation (recommended)
+You can install the SDK using
+```shell
+bower install instabug-sdk --save
+```
+### Initialize the SDK
+After including the sdk js file, you can start it by invoke the `.init()` method and pass the application token as parameter
+```html
 <script>
   ibgSdk.init({
      token: <INSTABUG_APP_TOKEN>
   });
 </script>
 ```
 
-### API Documentation
+### API Refrence
 
 #### `.init(options)`
-the init function is used to used to inintialize the sdk for the first time, it accepts the options object as parameter, 
-the `options` object in now accept only the `token`.
+the init function is used to used to initialize the SDK and render the report bug button.
+##### Parameters
+**options**: `Object` _required_ -  pass the application `token`
 
 #### `.disable()`
 used to hide the report bug button
diff --git a/css/styles.css b/css/styles.css
@@ -1,5 +1,6 @@
 body {
   min-height: 75rem; /* Can be removed; just added for demo purposes */
+  font-family: "Helvetica Neue",Arial,sans-serif;
 }
 
 .navbar {
diff --git a/index.html b/index.html
@@ -15,12 +15,6 @@
 
     <!-- Custom styles for this template -->
     <link href="css/styles.css" rel="stylesheet">
-    <script id='instabugSDK'>
-      window._instabug = window._instabug || {
-        token: 'c48e32c9888e063a107eb5d6ad75e70a'
-      }
-    </script>
-    <script src='https://s3.amazonaws.com/instabug-staging/sdk_releases/instabugsdk-custom-1.0.0.min.js?1488297380'></script>
   </head>
 
   <body>
@@ -53,7 +47,7 @@ <h4 class="text-white">Reach Us</h4>
 
     <section class="jumbotron text-center">
       <div class="container">
-        <h1 class="jumbotron-heading">Instabug Web SDK version 1.0</h1>
+        <h1 class="jumbotron-heading">Instabug Web SDK <small><code class="text-danger">1.1.1-beta</code></small></h1>
         <p class="lead text-muted">The top apps in the world rely on Instabug for beta testing, user engagement and crash reporting.
 Gather feedback from your beta testers and have live conversations with your users.</p>
         <p>
@@ -68,14 +62,17 @@ <h1 class="jumbotron-heading">Instabug Web SDK version 1.0</h1>
         <div class="row">
           <div class="card">
             <img data-src="holder.js/100px280?random=yes" alt="Card image cap">
+            <h3>Sample Header</h3>
             <p class="card-text">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Reiciendis, eum error, sequi non iure asperiores a blanditiis eos aliquid omnis voluptatibus sit illum repellendus provident ad, id impedit. Eos, mollitia!</p>
           </div>
           <div class="card">
-            <img data-src="holder.js/100px280?random=yes" alt="Card image cap">
+            <iframe src="https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d361451.7886363564!2d-122.24483737767562!3d37.53470456291936!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x808f778c55555555%3A0xa4f25c571acded3f!2sSan+Francisco+International+Airport+(SFO)!5e0!3m2!1sen!2seg!4v1493565982714" width="355" height="280" frameborder="0" style="border:0" allowfullscreen></iframe>
+            <h3>Map</h3>
             <p class="card-text">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Reiciendis, eum error, sequi non iure asperiores a blanditiis eos aliquid omnis voluptatibus sit illum repellendus provident ad, id impedit. Eos, mollitia!</p>
           </div>
           <div class="card">
-            <img data-src="holder.js/100px280?random=yes" alt="Card image cap">
+            <iframe width="355" height="280" src="https://www.youtube.com/embed/2MpUj-Aua48" frameborder="0" allowfullscreen></iframe>
+            <h3>Youtube Video</h3>
             <p class="card-text">Lorem ipsum dolor sit amet, consectetur adipisicing elit. Reiciendis, eum error, sequi non iure asperiores a blanditiis eos aliquid omnis voluptatibus sit illum repellendus provident ad, id impedit. Eos, mollitia!</p>
           </div>
           <div class="card">
@@ -101,10 +98,6 @@ <h1 class="jumbotron-heading">Instabug Web SDK version 1.0</h1>
         </p>
       </div>
     </footer>
-
-    <!-- Bootstrap core JavaScript
-    ================================================== -->
-    <!-- Placed at the end of the document so the pages load faster -->
     <script src="https://code.jquery.com/jquery-3.1.1.slim.min.js" integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n" crossorigin="anonymous"></script>
     <script>window.jQuery || document.write('<script src="../../assets/js/vendor/jquery.min.js"><\/script>')</script>
     <script src="js/holder.min.js"></script>
@@ -114,5 +107,11 @@ <h1 class="jumbotron-heading">Instabug Web SDK version 1.0</h1>
       });
     </script>
     <script src="js/bootstrap.min.js"></script>
+    <script src="js/instabug-sdk.min.js"></script>
+    <script>
+        ibgSdk.init({
+            token: 'c48e32c9888e063a107eb5d6ad75e70a'
+        });
+    </script>
   </body>
 </html>
diff --git a/js/instabug-sdk.min.js b/js/instabug-sdk.min.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`body {`
`2`	`2`	`min-height: 75rem; /* Can be removed; just added for demo purposes */`
	`3`	`+ font-family: "Helvetica Neue",Arial,sans-serif;`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`.navbar {`