diff --git a/README.md b/README.md index dc5b460..d9d8972 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Rocket.Chat.RealTime.API.Abstraction -Abstraction for Utilizing Rocket.Chat's Realtime API Methods with RxJS +Abstraction for Utilizing [Rocket.Chat](https://rocket.chat/)'s [Realtime API](https://rocket.chat/docs/developer-guides/realtime-api) Methods with [RxJS](http://reactivex.io/rxjs/) ## Installation ``` @@ -38,11 +38,14 @@ realTimeAPI.keepAlive(); | 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. | | loginWithOAuth(credToken, credSecret) | Returns Observable to the Result/Response from the RealTime API. | -| callMethod(methodName, ...params) | Returns Observalble to the Result of Method Call from Rocket.Chat Realtime API | +| callMethod(methodName, ...params) | Returns Observable to the Result of Method Call from Rocket.Chat Realtime API | | sendMessage(jsonObject) | Sends the JSON Object to the API Server | | onMessage( message => console.log(message) ) | Subscribes to the Messages sent from the server | | onError( error => console.error(error) ) | Subscribes to the Errors. | -| onCompletion( () => console.info("Complete") ) | Subscribes to Completion on the Websocket Connection | -| subscribe(messageHandler, errorHandler, completionHandler) | Subscribes to All 3, messages, errors and completion | +| onCompletion(() => console.info("Complete")) | Subscribes to Completion on the Websocket Connection | +| subscribe(messageHandler, errorHandler, completionHandler) | Subscribes to All three i.e - messages, errors and completion | | getObservable() | Returns observable of the WebSocket Connection to the RealTime API | -| | | \ No newline at end of file +| | | + + +### Checkout the Rocket.Chat's [RealTime API documentation](https://rocket.chat/docs/developer-guides/realtime-api) for furter information on working of the RealTime API.