TT#2723 Serveral changes related to the publication on npm

Change-Id: I60e5f101394137ac5be221c345a5aaa560dbcc5c
changes/56/9356/1
Hans-Peter Herzog 10 years ago
parent a5311ede07
commit 9817a3936b

@ -0,0 +1,54 @@
JanusVideoroomClient
====================
Node.js client that implements a subset of the WebSocket interface of the Janus WebRTC Gateway.
Note: For now it supports the videoroom plugin only.
### Setup
```javascript
var JanusVideoroomClient = require('janus-videoroom-client').Janus;
```
### Create a new client
#### Without authentication
```javascript
var client = new JanusVideoroomClient({
url: 'ws://localhost:8188'
});
```
#### Token based authentication
```javascript
var client = new JanusVideoroomClient({
url: 'ws://localhost:8188',
token: 'yourToken'
});
```
#### Static secret authentication
```javascript
var client = new JanusVideoroomClient({
url: 'ws://localhost:8188',
apiSecret: 'yourStaticSecret'
});
```
Run tests
---------
npm test

@ -1,13 +1,16 @@
{
"name": "janus-client",
"name": "janus-videoroom-client",
"version": "1.0.1",
"main": "src/janus.js",
"scripts": {
"test": "mocha -R spec --full-trace test/*-spec.js"
},
"author": "Hans-Peter Herzog <hherzog@sipwise.com>",
"license": "ISC",
"license": "GPL-3.0",
"description": "",
"keywords": [
"janus"
],
"dependencies": {
"bluebird": "^3.4.1",
"chai": "^3.5.0",

Loading…
Cancel
Save