You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by sh...@apache.org on 2016/06/22 23:37:59 UTC

cordova-plugin-wkwebview-engine git commit: Update README.md

Repository: cordova-plugin-wkwebview-engine
Updated Branches:
  refs/heads/master 639c6cbbc -> 7495b04d8


Update README.md

This closes #9

I had a lot of trouble understanding why my app would not load. It turns out that the answer was at the bottom of the README. I've the moved required configuration up to the installation section and made some minor edits. This should help some other users.


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine/commit/7495b04d
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine/tree/7495b04d
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine/diff/7495b04d

Branch: refs/heads/master
Commit: 7495b04d81f9fa419da4b9b498ab6ace3cbf1c57
Parents: 639c6cb
Author: Tony Laidig <la...@gmail.com>
Authored: Wed May 4 15:27:29 2016 -0400
Committer: Shazron Abdullah <sh...@apache.org>
Committed: Wed Jun 22 16:36:47 2016 -0700

----------------------------------------------------------------------
 README.md | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-wkwebview-engine/blob/7495b04d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 360580f..caa9ed0 100644
--- a/README.md
+++ b/README.md
@@ -29,28 +29,37 @@ In iOS 9, Apple has fixed the [issue](http://www.openradar.me/18039024) present
 Installation
 -----------
 
-This plugin needs to use at least cordova-ios 4.0.0.
+This plugin needs cordova-ios >4.0.0.
 
-To test this while it is still in development:
+To install the current release:
 
     cordova create wkwvtest my.project.id wkwvtest
     cd wkwvtest
-    cordova platform add https://github.com/apache/cordova-ios.git#master
-    cordova plugin add https://github.com/apache/cordova-plugin-wkwebview-engine.git#master
-	
+    cordova platform add ios@4
+    cordova plugin add cordova-plugin-wkwebview-engine
 
-Once cordova-ios 4.0.0 and the plugin is released on npm, you can just do:
+To test the development version:
 
     cordova create wkwvtest my.project.id wkwvtest
     cd wkwvtest
-    cordova platform add ios@4
-    cordova plugin add cordova-plugin-wkwebview-engine
-
+    cordova platform add https://github.com/apache/cordova-ios.git#master
+    cordova plugin add https://github.com/apache/cordova-plugin-wkwebview-engine.git#master
 
-You also must have Xcode 7 (iOS 9 SDK) installed. Check which Xcode command-line tools is in use by running:
+You also must have Xcode 7 (iOS 9 SDK) installed. Check your Xcode version by running:
 
     xcode-select --print-path
 
+Required Permissions
+-----------
+WKWebView may not fully launch (the deviceready event may not fire) unless if the following is included in config.xml:
+#### config.xml
+
+        <feature name="CDVWKWebViewEngine">
+            <param name="ios-package" value="CDVWKWebViewEngine" />
+        </feature>
+
+        <preference name="CordovaWebViewEngine" value="CDVWKWebViewEngine" />
+
 
 Notes
 ------
@@ -74,16 +83,7 @@ Apple Issues
 
 The `AllowInlineMediaPlayback` preference will not work because of this [Apple bug](http://openradar.appspot.com/radar?id=6673091526656000). 
 
-Permissions
------------
 
-#### config.xml
-
-        <feature name="CDVWKWebViewEngine">
-            <param name="ios-package" value="CDVWKWebViewEngine" />
-        </feature>
-
-        <preference name="CordovaWebViewEngine" value="CDVWKWebViewEngine" />
 
 Supported Platforms
 -------------------


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org