Merge branch 'develop'

Author: knowledgecode

CHANGELOG.md

@@ -1,4 +1,7 @@
 ## Change Log
+#### 0.9.1
+* updated only documents  
+
 #### 0.9.0
 * integrated with jetty-8.1.17.v20150415  
 * performance improvement (about 10% to 25% faster than previous versions)  

README.md

@@ -5,7 +5,7 @@ This is based on [Jetty 8](https://github.com/eclipse/jetty.project/tree/jetty-8
 ## 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` (since `cordova-android@4.0.0`)  
+ - `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0` or later  
 
 The plugin for Cordova 2.x can be found [here](https://github.com/knowledgecode/WebSocket-for-Android/tree/2.x).  
 
@@ -27,20 +27,27 @@ The plugin for Cordova 2.x can be found [here](https://github.com/knowledgecode/
  - 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) or 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 target Android 5.x (Lolipop), would be better to build with `cordova-android@3.7.1` or later.  
+ - If include Android 5.x (Lollipop) as target, would be better to build with `cordova-android@3.7.1` or later.  
 
 ## Installation
-Use Cordova Command-Line Interface (CLI):
+Use Cordova Command-Line Interface (CLI). At first, check Cordova version:
+```sh
+$ cordova --version
+```
+If using 5.0.0 or later:
 ```sh
 $ cordova plugin add cordova-plugin-websocket
 ```
-Can also install this from the GitHub repository:  
+If using other old versions:
 ```sh
 $ cordova plugin add https://github.com/knowledgecode/WebSocket-for-Android.git
 ```
 
 #### Caveats
-Previous plugin id `com.knowledgecode.cordova.websocket` is deprecated. It will be installed old version of this if use it.  
+Cordova core plugins have been moved to npm from Cordova plugins registry (CPR). This plugin has been moved as well. It will be **no longer updated** in CPR, but can still install it from there for now:
+```sh
+$ cordova plugin add com.knowledgecode.cordova.websocket
+```
 
 #### Setting a Content-Security-Policy (CSP)
 `cordova-android@4.0.0` supports SCP. In order to permit WebSocket access using `cordova-plugin-whitelist`, append `connect-src` directive in `index.html`:
@@ -54,17 +61,16 @@ For example:
 ```
 
 ## Upgrading from previous versions
-Just remove and re-install:  
+Check the plugin id:
 ```sh
-$ cordova plugin remove cordova-plugin-websocket
-$ cordova plugin add cordova-plugin-websocket
+$ cordova plugin
 ```
-If using v0.8.x or earlier, the plugin id is different:
+Remove and reinstall:
 ```sh
-$ cordova plugin remove com.knowledgecode.cordova.websocket
+$ cordova plugin rm <PLUGIN ID>
 $ cordova plugin add cordova-plugin-websocket
 ```
-Also will need to install `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist`.
+Also will need to install `cordova-plugin-whitelist` or `cordova-plugin-legacy-whitelist` if using `cordova-android@4.0.0`.
 
 #### 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.  

package.json

@@ -1,9 +1,9 @@
 {
   "name": "cordova-plugin-websocket",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Cordova WebSocket Plugin for Android",
   "cordova": {
-    "id": "com.knowledgecode.cordova.websocket",
+    "id": "cordova-plugin-websocket",
     "platforms": [
       "android"
     ]

plugin.xml

@@ -3,7 +3,7 @@
 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
   xmlns:android="http://schemas.android.com/apk/res/android"
   id="cordova-plugin-websocket"
-  version="0.9.0">
+  version="0.9.1">
   <name>WebSocket for Android</name>
   <description>Cordova WebSocket Plugin for Android</description>
   <license>Apache 2.0</license>

src/android/com/knowledgecode/cordova/websocket/WebSocket.java

@@ -35,7 +35,7 @@
  * This plugin is using Jetty under the terms of the Apache License v2.0.
  *
  * @author KNOWLEDGECODE <knowledgecode@gmail.com>
- * @version 0.9.0
+ * @version 0.9.1
  */
 public class WebSocket extends CordovaPlugin {
 

www/websocket.js

@@ -21,7 +21,7 @@
 /**
  * Cordova WebSocket Plugin for Android
  * @author KNOWLEDGECODE <knowledgecode@gmail.com>
- * @version 0.9.0
+ * @version 0.9.1
  */
 (function (window) {
     'use strict';