From 9213a11da9a02f61c9bff19cbbcce24f968c9e0d Mon Sep 17 00:00:00 2001 From: Viraj Trivedi Date: Thu, 22 Jun 2017 19:22:56 +0530 Subject: [PATCH] Update README.md Fixed Mistake in Method's Description and Usage Documentation --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index d9d8972..513b361 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,6 @@ 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. @@ -33,7 +29,7 @@ realTimeAPI.keepAlive(); | Methods | Functionality | |------------------------------------------------------------ |----------------------------------------------------------------------------------------------- | -| connectToServer() | Connects to the RealTime API. | +| connectToServer() | Initiates Connections to the Server to the RealTime API. Returns Observable with the server's response | | keepAlive() | Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive. | | login(username, password) | Returns Observable to the Result/Response from the RealTime API. | | loginWithAuthToken(authToken) | Returns Observable to the Result/Response from the RealTime API. |