@voicenter-team/opensips-js 1.0.89 → 1.0.91

package/README.md

@@ -1,13 +1,21 @@
+---
+title: Getting started
+description: The Opensips JS library and its expansive ecosystem offer developers a powerful and flexible solution for integrating Opensips protocol functionalities into a multitude of applications.
+navigation:
+  title: Getting Started
+---
+
 # Getting started
+
 ## Installation
 Using npm:
-```shell
+```shell[Terminal]
 $ npm i @voicenter-team/opensips-js
 ```
 
 ## Usage
 Firstly lets import the library and create the OpenSIPS instance:
-```javascript
+```javascript [file.js]
 import OpenSIPSJS from '@voicenter-team/opensips-js'
 
 const openSIPSJS = new OpenSIPSJS({
@@ -36,13 +44,13 @@ const openSIPSJS = new OpenSIPSJS({
 ```
 
 Then you can work with appropriate modules:
-```javascript
+```javascript [file.js]
 openSIPSJS.audio
 openSIPSJS.video
 openSIPSJS.msrp
 ```
 
-# OpensipsJS
+## OpensipsJS
 ### OpensipsJS instance methods
 - `begin(): OpensipsInstance` - start opensips
 - `on(event: OpensipsEvent, callback): void` - remove event listener
@@ -87,7 +95,7 @@ Also, there are next public fields on OpensipsJS instance:
 ### OpensipsJS instance fields
 - `sipDomain: String` - returns sip domain
 
-# Audio
+## Audio
 
 ### Audio methods
 - `initCall(target: String, addToCurrentRoom: Boolean): void` - call to the target. If addToCurrentRoom is true then the call will be added to the user's current room
@@ -124,7 +132,7 @@ Also, there are next public fields on OpensipsJS instance:
 - `isDND: Boolean` - returns if the agent is in "Do not disturb" status
 - `isMuted: Boolean` - returns if the agent is muted
 
-# MSRP
+## MSRP
 
 ### MSRP methods
 - `initMSRP(target: String, body: String): void` - initialize connection with target contact. Body is the initial message to this target.
@@ -136,7 +144,7 @@ Also, there are next public fields on OpensipsJS instance:
 - `getActiveMessages: { [key: string]: IMessage }` - returns an object of active message sessions where key is session id and value is message session data.
 
 
-# Video
+## Video
 
 ### Video methods
 - `joinRoom(roomId: String, displayName: String, mediaConstraints: Object): void` - join conference room