add readme file

migaber · web-flow · commit ae5c60ed427a · 2017-04-26T17:30:47.000+02:00
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# Instabug web SDK
+
+Instabug web sdk is a javascript library to add ability to report bugs from your website and report it to Instabug dashboard.
+
+### Install Instabug
+to 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>
+<script>
+  ibgSdk.init({
+     token: <INSTABUG_APP_TOKEN>
+  });
+</script>
+```
+
+### API Documentation
+
+#### `.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`.
+
+#### `.disable()`
+used to hide the report bug button
+
+#### `.enable()`
+used to show the report bug button
