diff --git a/README.md b/README.md index 4884e6c..fd8db1c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # smartsocket -easy and secure websocket communication +easy and secure websocket communication, Typescript ready ## Status [![build status](https://gitlab.com/pushrocks/smartsocket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master) ## Usage We recommend the use of typescript. +Under the hood we use socket.io and shortid for managed data exchange. ### Serverside ```typescript @@ -50,7 +51,6 @@ let mySmartsocketClient = new smartsocket.SmartsocketClient({ let mySocketFunction2 = new smartsocket.SocketFunction({ name:"restart", func:(data) => {}, the function to execute - roles: [mySocketRole] // all roles that have access to a specific function }); mySmartsocketClient.registerFunction(mySocketFunction2); @@ -59,4 +59,6 @@ mySmartsocketClient.serverCall("newService",data) .then((responseData) => { });; -``` \ No newline at end of file +``` + +> **NOTE:** you can easily chain dependent requests on eiter the server or client side with promises. `data` is always a js object that you can design for your specific. It supports buffers for large binary data network exchange. \ No newline at end of file diff --git a/package.json b/package.json index 25f5818..6602e40 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "smartsocket", "version": "1.0.2", - "description": "easy and secure websocket communication", + "description": "easy and secure websocket communication, Typescript ready", "main": "dist/index.js", "typings": "dist/index.d.ts", "scripts": { @@ -29,6 +29,7 @@ "taskbuffer": "^1.0.7" }, "devDependencies": { + "npmts-g": "^5.2.8", "should": "^10.0.0", "typings-test": "^1.0.1" }