updates

1 files changed, 52 insertions, 7 deletions

diff --git a/plugins/cordova-plugin-crosswalk-webview/README.md b/plugins/cordova-plugin-crosswalk-webview/README.md
index cb5d8f9a..768990a8 100644
--- a/plugins/cordova-plugin-crosswalk-webview/README.md
+++ b/plugins/cordova-plugin-crosswalk-webview/README.md
@@ -3,11 +3,27 @@
 Makes your Cordova application use the [Crosswalk WebView](https://crosswalk-project.org/)
 instead of the System WebView. Requires cordova-android 4.0 or greater.
 
+### Benefits
+
+* WebView doesn't change depending on Android version
+* Capabilities: such as WebRTC, WebAudio, Web Components
+* Performance improvements (compared to older system webviews)
+
+
+### Drawbacks
+
+* Increased memory footprint
+  * An overhead of ~30MB (as reported by the RSS column of ps)
+* Increased APK size (about 17MB)
+* Increased size on disk when installed (about 50MB)
+* Crosswalk WebView stores data (IndexedDB, LocalStorage, etc) separately from System WebView
+  * You'll need to manually migrate local data when switching between the two (note: this is fixed in Crosswalk 15)
+
 ### Install
 
 The following directions are for cordova-cli (most people).  Alternatively you can use the [Android platform scripts workflow](PlatformScriptsWorkflow.md).
 
-* Open an existing cordova project, with cordova-android 4.0.0+, and using the latest CLI.
+* Open an existing cordova project, with cordova-android 4.0.0+, and using the latest CLI. Crosswalk variables can be configured as an option when installing the plugin
 * Add this plugin
 
 ```
@@ -35,25 +51,54 @@ To build Crosswalk-enabled apks, add this plugin and run:
 
 To build System-webview apk, remove this plugin and run:
 
-    $ cordova build --release -- --android-minSdkVersion=21
+    $ cordova build --release -- --minSdkVersion=21
 
 ### Configure
 
-You can try out a different Crosswalk version using a `<preference>` tag within your `config.xml`. Some examples:
+You can try out a different Crosswalk version by specifying certain variables while installing the plugin, or by changing the value of `xwalkVersion` in your `config.xml` after installing the plugin. Some examples:
+
+    <!-- These are all equivalent -->
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="org.xwalk:xwalk_core_library:14+"
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="xwalk_core_library:14+"
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="14+"
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="14"
+    <preference name="xwalkVersion" value="org.xwalk:xwalk_core_library:14+" />
+    <preference name="xwalkVersion" value="xwalk_core_library:14+" />
+    <preference name="xwalkVersion" value="14+" />
+    <preference name="xwalkVersion" value="14" />
+
+You can also use a Crosswalk beta version. Some examples:
 
     <!-- These are all equivalent -->
-    <preference name="xwalkVersion" value="org.xwalk:xwalk_core_library_beta:13+" />
-    <preference name="xwalkVersion" value="xwalk_core_library_beta:13+" />
-    <preference name="xwalkVersion" value="13+" />
-    <preference name="xwalkVersion" value="13" />
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="org.xwalk:xwalk_core_library_beta:14+"
+    <preference name="xwalkVersion" value="org.xwalk:xwalk_core_library_beta:14+" />
 
 You can set [command-line flags](http://peter.sh/experiments/chromium-command-line-switches/) as well:
 
     <!-- This is the default -->
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_COMMANDLINE="--disable-pull-to-refresh-effect"
     <preference name="xwalkCommandLine" value="--disable-pull-to-refresh-effect" />
 
+You can use the Crosswalk [shared mode](https://crosswalk-project.org/documentation/shared_mode.html) which allows multiple Crosswalk applications to share one Crosswalk runtime downloaded from the Play Store.
+
+    <!-- These are all equivalent -->
+    cordova plugin add cordova-plugin-crosswalk-webview  --variable XWALK_MODE="shared"
+    <preference name="xwalkMode" value="shared" />
+Note that if you want to specify the Crosswalk version when using shared mode, you need to use the shared version of the library, e.g.: 
+
+    <!-- Using a Crosswalk shared mode beta version -->
+    cordova plugin add cordova-plugin-crosswalk-webview --variable XWALK_VERSION="org.xwalk:xwalk_shared_library_beta:14+"
+
+
 ### Release Notes
 
+#### 1.3.0 (August 28, 2015)
+* Crosswalk variables can be configured as an option via CLI
+* Support for [Crosswalk's shared mode](https://crosswalk-project.org/documentation/shared_mode.html) via the XWALK_MODE install variable or xwalkMode preference
+* Uses the latest Crosswalk 14 stable version by default
+* The ANIMATABLE_XWALK_VIEW preference is false by default
+* Doesn't work with Crosswalk 14.43.343.17 and earlier
+
 #### 1.2.0 (April 22, 2015)
 * Made Crosswalk command-line configurable via `<preference name="xwalkCommandLine" value="..." />`
 * Disabled pull-down-to-refresh by default