From 9817a3936b8c02dd5e1e2c692d97cf349d7a02ba Mon Sep 17 00:00:00 2001 From: Hans-Peter Herzog Date: Mon, 7 Nov 2016 14:59:18 +0100 Subject: [PATCH] TT#2723 Serveral changes related to the publication on npm Change-Id: I60e5f101394137ac5be221c345a5aaa560dbcc5c --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 7 +++++-- 2 files changed, 59 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e69de29..19c51dc 100644 --- a/README.md +++ b/README.md @@ -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 + + + + + + + + diff --git a/package.json b/package.json index 772bded..d5d2973 100644 --- a/package.json +++ b/package.json @@ -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 ", - "license": "ISC", + "license": "GPL-3.0", "description": "", +"keywords": [ + "janus" +], "dependencies": { "bluebird": "^3.4.1", "chai": "^3.5.0",