Create README.md

Added Readme

README.md

@@ -0,0 +1,110 @@
+# SimpleAndroidBridge
+
+Build a bridge! This library is created to create a powerful interface between Android and Webapp.
+
+✓ Share Objects - Android ⇄ Web
+
+✓ Share Promise - Android ⇄ Web
+
+✓ Callback Functions - Android ← Web
+
+✓ Call Functions non-blocking - Android ⇄ Web
+
+✓ Type safety with typescript - Android + Web
+
+## Setup
+
+Add the libary to your android project.
+
+```
+implementation 'com.github.andycandy-de:simple-android-bridge:1.0.0-BETA-b01'
+```
+
+Create your interface.
+
+```
+interface AndroidInterface {
+
+    @NativeCall(CallType.FULL_SYNC)
+    fun helloFullSync(name: String): String
+
+    @NativeCall(CallType.WEB_PROMISE)
+    fun helloWebPromise(name: String): String
+
+    @NativeCall(CallType.FULL_PROMISE)
+    fun helloFullPromise(name: String): Promise<String>
+}
+```
+
+Add the implementation.
+
+```
+class AndroidNativeInterface: DefaultJSInterface("Android"), AndroidInterface {
+
+    override fun helloFullSync(name: String): String {
+        return "hello $name"
+    }
+
+    override fun helloWebPromise(name: String): String {
+        return "hello $name"
+    }
+
+    override fun helloFullPromise(name: String) = doInBackground<String> { promise ->
+        promise.resolve("hello $name")
+    }
+}
+```
+
+Create the bridge and add the interface.
+
+```
+val bridge = Bridge(applicationContext, webView)
+bridge.addJSInterface(AndroidNativeInterface(this@MainActivity))
+```
+
+Initialize the bridge via web or via android.
+
+Android
+
+```
+webView.webViewClient = object : WebViewClient() {
+
+    override fun onPageFinished(view: WebView?, url: String?) {
+        bridge.init()
+    }
+}
+```
+
+Web via Javascript
+
+```
+Bridge.init()
+
+Bridge.afterInitialize = () => {
+    // Start your webapp
+}
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2020 andycandy-de
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.