Merge pull request #24 from ClusterWS/next

Release for 1.5.0

Author: goriunov

.gitignore

@@ -1,7 +1,8 @@
-
 .npm
 .idea/
 .vscode/
+.builder/cache/
 
 node_modules/
-package-lock.json
+package-lock.json
+

README.md

@@ -1,162 +1,20 @@
 <h1 align="center">ClusterWS JavaScript Client</h1> 
-<h6 align="center">WebSocket & Node JS Cluster</h6>
+<h6 align="center">Build Scalable Node.js WebSocket Applications</h6>
 
 <p align="center">
-    <img alt="Node.js" src="http://u.cubeupload.com/goriunovd/clusterWS.png" width="560"/>
+ <img src="https://cdn.rawgit.com/goriunov/159120ca6a883d8d4e75543ec395d361/raw/f4c3c36ac1ab75beedcf73312272b60dac33ecfa/clusterws.svg" width="500">
 </p>
 
 <p align="center">
  <a title="NPM Version" href="https://badge.fury.io/js/clusterws-client-js"><img src="https://badge.fury.io/js/clusterws-client-js.svg"></a>
  <a title="GitHub version" href="https://badge.fury.io/gh/goriunov%2FClusterWS-Client-JS"><img src="https://badge.fury.io/gh/goriunov%2FClusterWS-Client-JS.svg"></a>
 </p>
 
-**This README, logo and animation will be changed soon, we are currently implementing new GUIDES in wikis and working with new logo and animation**
-
-## Overview
-This is official JavaScript client for [ClusterWS](https://github.com/ClusterWS/ClusterWS).
-
-[ClusterWS](https://github.com/ClusterWS/ClusterWS) - is a minimal **Node JS http & real-time** framework which allows to scale WebSocket ([uWS](https://github.com/uNetworking/uWebSockets) - one of the fastest WebSocket libraries) between **Workers** in [Node JS Cluster](https://nodejs.org/api/cluster.html) and utilize all available CPU.
-
-**Current minified version is under 6KB.**
-
-**This library requires [ClusterWS](https://github.com/ClusterWS/ClusterWS) on the server**
-
-## Installation
-To install ClusterWS Client JS run:
-```js
-npm install --save clusterws-client-js
-```
-or use globally: 
-
-1. Find `ClusterWS.(min).js`  in `dist/browser` folder.
-2. Use standard script tag to import library `<script src="path/to/ClusterWS.[min].js"></script>`.
-3. Done, now you can use it as `ClusterWS`.
-
-
-## Socket
-### 1. Connecting
-You can connect to the server with the following code: 
-```js
-var cws = new ClusterWS({
-    url: 'localhost',
-    port: 80
-})
-```
-
-in case if you are using builders like `webpack` and `npm` then you need to import library at the top with: 
-```js
-var ClusterWS = require('clusterws-client-js').ClusterWS
-```
-
-*All available options of ClusterWS:*
-```js
-{
-    url: '{string} url of the server without http or https. (must be provided)',
-    port: '{number} port of the server. (must be provided)',
-    autoReconnect: '{boolean} allow to auto-reconnect to the server on lost connection. (default false)',
-    reconnectionIntervalMin: '{number} how long min time waut. (default 1000) in ms', 
-    reconnectionIntervalMax: '{number} how long max time wait. (default 5000) in ms', 
-    reconnectionAttempts: '{number} how many times to try, 0 means without limit. (default 0)',
-    secure: '{boolean} user secure connection or not wss/ws. (default false)'
-}
-```
-
-*Auto reconnect count random time between Max and Min interval value this will reduce amount of users which are connection at the same time on reconnection and reduce server load on restart of the server*
-
-### 2. Listen on events
-To listen on events from the server you should use `on` method witch is provided by `cws`
-```js
-/**
-    event name: string - can be any string you wish
-    data: any - is what you send from the client
-*/
-cws.on('event name', function(data){
-    // in here you can write any logic
-})
-```
-
-*Also `cws` gets **Reserved Events** such as `'connect'`, `'disconnect'` and `'error'`*
-```js
-cws.on('connect', function(){
-    // in here you can write any logic
-})
-
-/**
-    err: any - display the problem with your weboscket
-*/
-cws.on('error', function(err){
-    // in here you can write any logic
-})
-
-/**
-    code: number - represent the reason in number
-    reason: string - reason why your socket was disconnected
-*/
-cws.on('disconnect', function(code, reason){
-    // in here you can write any logic
-})
-```
-
-### 3. Send events
-To send events to the server use `send` method witch is provided by `cws`
-```js
-/**
-    event name: string - can be any string you wish (client must listen on this event name)
-    data: any - is what you want to send to the client
-*/
-cws.send('event name', data)
-```
-
-*Avoid emitting **Reserved Events** such as `'connect'`, `'connection'`, `'disconnect'` and `'error'`. Also avoid emitting  event and events with `'#'` at the start.*
-
-## Pub/Sub
-You can `subscribe`, `watch`, `unsubscribe` and `publish`, `getChannelByName` to/from the channels
-```js
-/**
-    channel name: string - can be any string you wish
-*/
-var channel = cws.subscribe('channel name')
-
-/**
-    data: any - is what you get when you or some one else publish to the channel
-*/
-channel.watch(function(data){
- // in here you can write any logic
-})
-
-/**
-    data: any - is what you want to publish to the channel (everyone who is subscribe will get it)
-*/
-channel.publish(data)
-
-/**
-    This method is used to unsubscribe from the channel
-*/
-channel.unsubscribe()
-
-/**
-    Also you can chain everything in one expression
-*/
-var channel = cws.subscribe('channel name').watch(function(data){
- // in here you can write any logic
-}).publish(data)
-
-
-/**
-    You can get channel by channel name only if you were subscribed before
-    You can use any methods as with usual channel
-*/
-cws.getChannelByName('channel name')
-
-```
-
-**To make sure that user is connected to the server before subscribing, do it on `connect` event or on any other events which you emit from the server, otherwise subscription may not work properly**
-
-## See Also
-* [Medium ClusterWS](https://medium.com/clusterws)
-* [ClusterWS Tests](https://github.com/ClusterWS/ClusterWS-Tests)
-* [ClusterWS Example Chat](https://github.com/goriunov/ClusterWS-Chat-Example)
-
-*Docs are still under development. If you have found any errors please submit pull request or leave issue*
+<p align="center">
+    <i>Official JavaScript Client library for <a href="https://github.com/ClusterWS/ClusterWS">ClusterWS</a> - lightweight, fast and powerful framework for building horizontally & vertically scalable WebSocket applications in Node.js</i>
+</p>
 
-## Happy coding !!! :sunglasses:
+<h1></h1>
+<h3 align="center">
+    <a href="https://github.com/ClusterWS/ClusterWS-Client-JS/wiki"><strong>ClusterWS JavaScript Client Documentation</strong></a>
+</h3>