add README

optimist-dev · Nov 23, 2020 · b910a63 · b910a63
1 parent 829d192
commit b910a63
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,44 @@
+# VK Bridge
+
+A package for integrating Flutter VK Mini Apps with official VK clients for iOS, Android and Web.
+
+This package is a wrapper around official [VK-Bridge](https://github.com/VKCOM/vk-bridge) JS package.
+
+## Usage
+
+On app start call `VKBridge.instance.init()` method before `runApp` to ensure correct VK Bridge initialization.
+
+```dart
+import 'package:vk_bridge/vk_bridge.dart';
+
+Future<void> main() async {
+  await VKBridge.instance.init();
+
+  runApp(MyApp());
+}
+```
+
+Add this part of code in your index.html before Flutter part.
+
+```html
+
+<script src="https://unpkg.com/@vkontakte/vk-bridge/dist/browser.min.js"></script>
+
+<script>
+    vkBridge.subscribe((event) => {
+        if (window.vkBridgeDartListener != null) {
+            window.vkBridgeDartListener(event.detail);
+        }
+    });
+</script>
+
+<script src="main.dart.js" type="application/javascript"></script>
+```
+
+To add logger use `VKBridge.instance.setLogger()`.
+
+### Original VK Bridge documentation: https://vk.com/dev/vk_bridge_events
+
+### Original VK Bridge JS package: https://github.com/VKCOM/vk-bridge
+
+
diff --git a/example/web/index.html b/example/web/index.html
@@ -30,10 +30,19 @@
   <link rel="manifest" href="manifest.json">
 </head>
 <body>
-<script src="https://unpkg.com/@vkontakte/vk-bridge/dist/browser.min.js"></script>
+  <script src="https://unpkg.com/@vkontakte/vk-bridge/dist/browser.min.js"></script>
   <!-- This script installs service_worker.js to provide PWA functionality to
        application. For more information, see:
        https://developers.google.com/web/fundamentals/primers/service-workers -->
+
+  <script>
+    vkBridge.subscribe((event) => {
+        if(window.vkBridgeDartListener != null){
+            window.vkBridgeDartListener(event.detail);
+        }
+    });
+  </script>
+
   <script>
     if ('serviceWorker' in navigator) {
       window.addEventListener('flutter-first-frame', function () {