From 115a0b28568df9f3d9bad9d60d79f37f1dd3bac0 Mon Sep 17 00:00:00 2001 From: Viraj Trivedi Date: Thu, 22 Jun 2017 18:36:05 +0530 Subject: [PATCH] Comments on the Next Line --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e22cf53..51e698a 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,7 @@ Abstraction for Utilizing Rocket.Chat's Realtime API Methods with RxJS ## Installation -``` -npm install --save rocket.chat.realtime.api.rxjs - -``` +` npm install --save rocket.chat.realtime.api.rxjs ` ## Usage @@ -16,19 +13,26 @@ import { RealTimeAPI } from "rocket.chat.realtime.api.rxjs"; const realTimeAPI = new RealTimeAPI("wss://demo.rocket.chat/websocket"); // Provide, URL to the Rocket.Chat's Realtime API. -realTimeAPI.connectToServer(); // Connects to the RealTime API -realTimeAPI.keepAlive(); // Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive. +realTimeAPI.connectToServer(); +// Connects to the RealTime API + + +realTimeAPI.keepAlive(); +// Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive. ... ... // Use any of the methods implmented in the package such as -login(username, password) //Returns Observable to the Result of the called method, in this case login +login(username, password); +//Returns Observable to the Result of the called method, in this case login -callMethod("method", ...params) // Generic Method to Call any of the method from RealTime API. Returns Observable to the Result of the called method +callMethod("method", ...params); +// Generic Method to Call any of the method from RealTime API. Returns Observable to the Result of the called method -callMethod("rooms/get",[{ "$date": Date.now() / 1000 }]); // Returns Observable to the Method called (rooms/get) with params [{ "$date": Date.now() / 1000 }]. +callMethod("rooms/get",[{ "$date": Date.now() / 1000 }]); +// Returns Observable to the Method called (rooms/get) with params [{ "$date": Date.now() / 1000 }]. ``` \ No newline at end of file