Updated README.md

Author: knowledgecode

README.md

@@ -1,11 +1,11 @@
 # WebSocket for Android [![GitHub version](https://badge.fury.io/gh/knowledgecode%2FWebSocket-for-Android.svg)](http://badge.fury.io/gh/knowledgecode%2FWebSocket-for-Android)
-WebSocket for Android is a Cordova plugin that allows WebSockets (RFC 6455) to be used on Android.  
+WebSocket for Android is a Cordova plugin that makes WebSocket (RFC 6455) available on Android.  
 This is based on [Jetty 8](https://github.com/eclipse/jetty.project/tree/jetty-8) under the terms of the Apache License v2.0.  
 
 ## Requirements
  - Android 2.3 or later (recommended 4.1 or later)  
  - `cordova-android@3.0.0` or later or compatible framework  
- - `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0` or later  
+ - `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0` and later  
 
 The plugin for Cordova 2.x can be found [here](https://github.com/knowledgecode/WebSocket-for-Android/tree/2.x).  
 
@@ -24,21 +24,21 @@ The plugin for Cordova 2.x can be found [here](https://github.com/knowledgecode/
 
 #### Notes
  - WSS protocol is only supported TLS. SSLv3 is not.  
- - Android 3.x (Honeycomb) are not supported (maybe work, but not tested).  
- - A new WebView based on Chromium supports WebSockets. Specifically Android 4.4 (KitKat) and later support them, so this plugin is **NOT** used on them by default.  
- - This plugin can be used [Crosswalk](https://crosswalk-project.org/) together in `cordova-android@4.0.0`. In this case also this is not used by default because it supports WebSockets.  
- - If include Android 5.x (Lollipop) as target, would be better to build with `cordova-android@3.7.1` or later.  
+ - Android 3.x (Honeycomb) are not supported (might work but is not tested).  
+ - A new WebView based on Chromium supports WebSocket. Specifically Android 4.4 (KitKat) and later support them, so this plugin is **NOT** used on them by default.  
+ - In `cordova-android@4.0.0` and later, this plugin can be used together with [Crosswalk](https://crosswalk-project.org/). In this case also it is not used by default because Crosswalk supports WebSocket.  
+ - To support Android 5.x (Lollipop), would be better to build with `cordova-android@3.7.1` or later.  
 
 ## Installation
 Use Cordova Command-Line Interface (CLI). At first, check Cordova version:
 ```sh
 $ cordova --version
 ```
-If using 5.0.0 or later:
+If using 5.0.0 or later (via npm):
 ```sh
 $ cordova plugin add cordova-plugin-websocket
 ```
-If using other old versions:
+If using other old versions (via GitHub):
 ```sh
 $ cordova plugin add https://github.com/knowledgecode/WebSocket-for-Android.git
 ```
@@ -70,7 +70,7 @@ Remove and reinstall:
 $ cordova plugin rm <PLUGIN ID>
 $ cordova plugin add cordova-plugin-websocket
 ```
-Also will need to install `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0`.
+Also will need to install `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0` and later.
 
 #### Caveats
 When install this plugin, it adds `INTERNET` permission to `platforms/android/AndroidManifest.xml`. If remove this plugin, the permission is also removed at the same time even if it is required for other plugins.  
@@ -103,29 +103,32 @@ document.addEventListener('deviceready', function () {
 }, false);
 ```
 #### Options
-This plugin has the following options. All these parameters are optional. Of course these don't affect native WebSocket.  
-
-| key                  | default value        | supported version        |
-|:---------------------|:---------------------|:-------------------------|
-| origin               | file:// (usually)    | v0.3.0 ~                 |
-| maxConnectTime       | 75000                | v0.4.0 ~                 |
-| maxTextMessageSize   | -1                   | v0.4.0 ~ (except v0.8.x) |
-| maxBinaryMessageSize | -1                   | v0.4.0 ~ (except v0.8.x) |
-| override             | false                | v0.8.0 ~                 |
-| agent                | (depends on devices) | v0.9.0 ~                 |
-
-`origin` is a value to set the request header field. Default value is usually `file://`. This is the same value as when using native WebSocket.  
+This plugin has the following options. All these parameters are optional. Of course these don't affect built-in WebSocket.  
+
+| key                  | type    | default value       | supported version        |
+|:---------------------|:--------|:--------------------|:-------------------------|
+| origin               | String  | file:// (usually)   | v0.3.0 ~                 |
+| maxConnectTime       | Number  | 75000               | v0.4.0 ~                 |
+| maxTextMessageSize   | Number  | -1                  | v0.4.0 ~ (except v0.8.x) |
+| maxBinaryMessageSize | Number  | -1                  | v0.4.0 ~ (except v0.8.x) |
+| override             | Boolean | false               | v0.8.0 ~                 |
+| agent                | String  | (depends on device) | v0.9.0 ~                 |
+| perMessageDeflate    | Boolean | false               | v0.10.0 ~                |
+
+`origin` is a value to set the request header field. Default value is usually `file://`. This is the same value as when using built-in WebSocket.  
 `maxConnectTime` is time to wait for connection. A unit is millisecond.  
-`maxTextMessageSize` and `maxBinaryMessageSize` are receivable maximum size from a server. Default value is -1 (unlimited. depends on heap size of devices). A unit is byte.  
-`override` is a flag to force WebView to use this plugin even if supports WebSockets. For example, in case that want to apply them these options. However will be slower than native WebSocket.  
-`agent` is user-agent to set the request header field. Default value depends on devices. This is the same value as when using native WebSocket.  
+`maxTextMessageSize` and `maxBinaryMessageSize` are receivable maximum size from the server. Default value is -1 (unlimited. depends on devices heap size). A unit is byte.  
+`override` is a flag to force WebView to use this plugin even if it supports WebSocket. However in most cases it will be slower than built-in WebSocket.  
+`agent` is user-agent to set the request header field. Default value depends on devices. This is the same value as when using built-in WebSocket.  
+`perMessageDeflate` is a flag whether to use permessage-deflate extension or not. Default value is false for now because it is still experimental. If you would like to try it, set to true. However It is necessary that the server supports permessage-deflate.  
 
 If change these parameters, need to do before creating a instance:  
 ```javascript
 WebSocket.pluginOptions = {
     origin: 'http://example.com',
     maxConnectTime: 5000,
-    override: true
+    override: true,
+    perMessageDeflate: true
 };
 
 var ws = new WebSocket('ws://echo.websocket.org');