Update README to document new API

marcuswestin · marcuswestin · commit ad1dabaf41bb · 2016-01-28T21:37:53.000-05:00
diff --git a/README.md b/README.md
@@ -73,10 +73,12 @@ self.bridge = [WebViewJavascriptBridge bridgeForWebView:webView handler:^(id dat
 3) Go ahead and send some messages from ObjC to javascript:
 
 ```objc
-[self.bridge send:@"Well hello there"];
-[self.bridge send:[NSDictionary dictionaryWithObject:@"Foo" forKey:@"Bar"]];
-[self.bridge send:@"Give me a response, will you?" responseCallback:^(id responseData) {
-	NSLog(@"ObjC got its response! %@", responseData);
+[self.bridge registerHandler:@"ObjC Echo" handler:^(id data, WVJBResponseCallback responseCallback) {
+	NSLog(@"ObjC Echo called with: %@", data);
+	responseCallback(data);
+}];
+[self.bridge callHandler:@"JS Echo" responseCallback:^(id responseData) {
+	NSLog(@"ObjC received response: %@", responseData);
 }];
 ```
 
@@ -95,24 +97,21 @@ function setupWebViewJavascriptBridge(callback) {
 }
 
 setupWebViewJavascriptBridge(function(bridge) {
-	bridge.init(function(message, responseCallback) {
-		alert('Received message: ' + message)   
-		if (responseCallback) {
-			responseCallback("Right back atcha")
-		}
-	})
 	
 	/* Initialize your app here */
 
-	bridge.send('Hello from the javascript')
-	bridge.send('Please respond to this', function responseCallback(responseData) {
-		console.log("Javascript got its response", responseData)
+	bridge.registerHandler('JS Echo', function(data, responseCallback) {
+		console.log("JS Echo called with:", data)
+		responseCallback(data)
+	})
+	bridge.callHandler('ObjC Echo', function responseCallback(responseData) {
+		console.log("JS received response:", responseData)
 	})
 })
 ```
 
-WKWebView Support (iOS 8 & OS 10.10)
-------------------------------------
+WKWebView Support (iOS 8+ & OS 10.10+)
+--------------------------------------
 
 WARNING: WKWebView still has [many bugs and missing network APIs.](https://github.com/ShingoFukuyama/WKWebViewTips/blob/master/README.md) It may not be a simple drop-in replacement.
 
@@ -128,10 +127,7 @@ WebViewJavascriptBridge supports [WKWebView](http://nshipster.com/wkwebkit/) for
 2) Instantiate WKWebViewJavascriptBridge and with a WKWebView object
 
 ```objc
-WKWebViewJavascriptBridge* bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView handler:^(id data, WVJBResponseCallback responseCallback) {
-	NSLog(@"Received message from javascript: %@", data);
-	responseCallback(@"Right back atcha");
-}];
+WKWebViewJavascriptBridge* bridge = [WKWebViewJavascriptBridge bridgeForWebView:webView];
 ```
 
 Contributors & Forks
@@ -145,41 +141,14 @@ API Reference
 
 ### ObjC API
 
-##### `[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview handler:(WVJBHandler)handler]`
-##### `[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview webViewDelegate:(UIWebViewDelegate*)webViewDelegate handler:(WVJBHandler)handler]`
+##### `[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webview`
 
 Create a javascript bridge for the given web view.
 
-The `WVJBResponseCallback` will not be `nil` if the javascript expects a response.
-
-Optionally, pass in `webViewDelegate:(UIWebViewDelegate*)webViewDelegate` if you need to respond to the [web view's lifecycle events](http://developer.apple.com/library/ios/documentation/uikit/reference/UIWebViewDelegate_Protocol/Reference/Reference.html).
-
 Example:
 
 ```objc	
-[WebViewJavascriptBridge bridgeForWebView:webView handler:^(id data, WVJBResponseCallback responseCallback) {
-	NSLog(@"Received message from javascript: %@", data);
-	if (responseCallback) {
-		responseCallback(@"Right back atcha");
-	}
-}]
-
-[WebViewJavascriptBridge bridgeForWebView:webView webViewDelegate:self handler:^(id data, WVJBResponseCallback responseCallback) { /* ... */ }];
-```
-
-##### `[bridge send:(id)data]`
-##### `[bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]`
-
-Send a message to javascript. Optionally expect a response by giving a `responseCallback` block.
-
-Example:
-
-```objc
-[self.bridge send:@"Hi"];
-[self.bridge send:[NSDictionary dictionaryWithObject:@"Foo" forKey:@"Bar"]];
-[self.bridge send:@"I expect a response!" responseCallback:^(id responseData) {
-	NSLog(@"Got response! %@", responseData);
-}];
+[WebViewJavascriptBridge bridgeForWebView:webView];
 ```
 
 ##### `[bridge registerHandler:(NSString*)handlerName handler:(WVJBHandler)handler]`
@@ -192,6 +161,10 @@ Example:
 [self.bridge registerHandler:@"getScreenHeight" handler:^(id data, WVJBResponseCallback responseCallback) {
 	responseCallback([NSNumber numberWithInt:[UIScreen mainScreen].bounds.size.height]);
 }];
+[self.bridge registerHandler:@"log" handler:^(id data, WVJBResponseCallback responseCallback) {
+	NSLog(@"Log: %@", data);
+}];
+
 ```
 
 ##### `[bridge callHandler:(NSString*)handlerName data:(id)data]`
@@ -208,82 +181,39 @@ Example:
 }];
 ```
 
-#### Custom bundle
-`WebViewJavascriptBridge` requires `WebViewJavascriptBridge.js.txt` file that is injected into web view to create a bridge on JS side. Standard implementation uses `mainBundle` to search for this file. If you e.g. build a static library and you have that file placed somewhere else you can use this method to specify which bundle should be searched for `WebViewJavascriptBridge.js.txt` file:
-
-##### `[WebViewJavascriptBridge bridgeForWebView:(UIWebView/WebView*)webView webViewDelegate:(UIWebViewDelegate*)webViewDelegate handler:(WVJBHandler)handler resourceBundle:(NSBundle*)bundle`
-
-Example:
-
-```objc
-[WebViewJavascriptBridge bridgeForWebView:_webView
-                          webViewDelegate:self
-                                  handler:^(id data, WVJBResponseCallback responseCallback) {
-                                      NSLog(@"Received message from javascript: %@", data);
-                                  }
-                           resourceBundle:[NSBundle bundleWithURL:[[NSBundle mainBundle] URLForResource:@"ResourcesBundle" withExtension:@"bundle"]]
-];
-```
-
-### Javascript API
+#### `[bridge setWebViewDelegate:UIWebViewDelegate*)webViewDelegate]`
 
-##### `document.addEventListener('WebViewJavascriptBridgeReady', function onBridgeReady(event) { ... }, false)`
+Optionally, set a `UIWebViewDelegate` if you need to respond to the [web view's lifecycle events](http://developer.apple.com/library/ios/documentation/uikit/reference/UIWebViewDelegate_Protocol/Reference/Reference.html).
 
-Always wait for the `WebViewJavascriptBridgeReady` DOM event.
 
-Example:
-
-```javascript
-document.addEventListener('WebViewJavascriptBridgeReady', function(event) {
-	var bridge = event.bridge
-	// Start using the bridge
-}, false)
-```
 
-##### `bridge.init(function messageHandler(data, response) { ... })`
 
-Initialize the bridge. This should be called inside of the `'WebViewJavascriptBridgeReady'` event handler.
+### Javascript API
 
-The `messageHandler` function will receive all messages sent from ObjC via `[bridge send:(id)data]` and `[bridge send:(id)data responseCallback:(WVJBResponseCallback)responseCallback]`.
+##### `bridge.registerHandler("handlerName", function(responseData) { ... })`
 
-The `response` object will be defined if if ObjC sent the message with a `WVJBResponseCallback` block.
+Register a handler called `handlerName`. The ObjC can then call this handler with `[bridge callHandler:"handlerName" data:@"Foo"]` and `[bridge callHandler:"handlerName" data:@"Foo" responseCallback:^(id responseData) { ... }]`
 
 Example:
 
 ```javascript
-bridge.init(function(data, responseCallback) {
-	alert("Got data " + JSON.stringify(data))
-	if (responseCallback) {
-		responseCallback("Right back atcha!")
-	}
+bridge.registerHandler("showAlert", function(data) { alert(data) })
+bridge.registerHandler("getCurrentPageUrl", function(data, responseCallback) {
+	responseCallback(document.location.toString())
 })
 ```
 
-##### `bridge.send("Hi there!")`
-##### `bridge.send({ Foo:"Bar" })`
-##### `bridge.send(data, function responseCallback(responseData) { ... })`
 
-Send a message to ObjC. Optionally expect a response by giving a `responseCallback` function.
+##### `bridge.callHander("handlerName", data, function responseCallback(responseData) { ... })`
 
-Example:
-
-```javascript
-bridge.send("Hi there!")
-bridge.send("Hi there!", function(responseData) {
-	alert("I got a response! "+JSON.stringify(responseData))
-})
-```
-
-##### `bridge.registerHandler("handlerName", function(responseData) { ... })`
-
-Register a handler called `handlerName`. The ObjC can then call this handler with `[bridge callHandler:"handlerName" data:@"Foo"]` and `[bridge callHandler:"handlerName" data:@"Foo" responseCallback:^(id responseData) { ... }]`
+Call an ObjC handler called `handlerName`. If `responseCallback` is defined, the ObjC handler can respond.
 
 Example:
 
 ```javascript
-bridge.registerHandler("showAlert", function(data) { alert(data) })
-bridge.registerHandler("getCurrentPageUrl", function(data, responseCallback) {
-	responseCallback(document.location.toString())
+bridge.callHandler("Log", "Foo")
+bridge.callHandler("getScreenHeight", null, function(response) {
+	alert('Screen height:' + response)
 })
 ```
 
