@@ -5,29 +5,29 @@ OBSWebSocket.JS allows Javascript-based connections to the Open Broadcaster plug
5
5
</i ></p >
6
6
7
7
<p align =" center " >
8
- <a href =" https://travis-ci.org/haganbmj/obs-websocket-js " ><img src =" https://img.shields.io/travis/haganbmj/obs-websocket-js/master.svg?style=flat " ></a >
9
- <a href =" https://coveralls.io/github/haganbmj/obs-websocket-js?branch=master " ><img src =" https://coveralls.io/repos/github/haganbmj/obs-websocket-js/badge.svg?branch=master " ></a >
10
- <a href =" https://libraries.io/bower/obs-websocket-js " ><img src =" https://img.shields.io/bower/v/obs-websocket-js.svg?style=flat " ></a >
11
- <a href =" https://www.npmjs.com/package/obs-websocket-js " ><img src =" https://img.shields.io/npm/v/obs-websocket-js.svg?style=flat " ></a >
12
- <a href =" https://www.npmjs.com/package/obs-websocket-js " ><img src =" https://img.shields.io/npm/dt/obs-websocket-js.svg " ></a >
13
- <img src =" https://img.shields.io/npm/l/obs-websocket-js.svg " >
14
- <a href =" https://greenkeeper.io/ " ><img src =" https://badges.greenkeeper.io/haganbmj/obs-websocket-js.svg " ></a >
8
+
9
+ [ ![ ] [ badge-build-status ]] [ link-Travis-CI ]
10
+ [ ![ ] [ badge-coveralls ]] [ link-Coveralls ]
11
+ [ ![ ] [ badge-npm-version ]] [ link-npm ]
12
+ [ ![ ] [ badge-npm-downloads ]] [ link-npm ]
13
+ [ ![ ] [ badge-npm-license ]] [ link-npm ]
15
14
</p >
16
15
17
- <p align =" center " ><b >
18
- <a href =" https://raw.githubusercontent.com/haganbmj/obs-websocket-js/gh-pages/dist/obs-websocket.js " >Download</a > |
19
- <a href =" https://github.com/haganbmj/obs-websocket-js/tree/master/samples " >Samples</a > |
20
- <a href =" https://github.com/haganbmj/obs-websocket-js/blob/gh-pages/CHANGELOG.md " >Changelog</a >
21
- </b ></p >
16
+ <p align =" center " >
17
+
18
+ ** [ Download] ( https://raw.githubusercontent.com/duncte123/obs-websocket-js/gh-pages/dist/obs-websocket.js ) ** |
19
+ ** [ Samples] ( https://github.com/duncte123/obs-websocket-js/tree/master/samples ) ** |
20
+ ** [ Changelog] ( https://github.com/duncte123/obs-websocket-js/blob/gh-pages/CHANGELOG.md ) **
21
+ </p >
22
22
23
23
## Installation
24
24
25
25
Please note that the version of obs-websocket-js matches the release version of obs-websocket
26
26
27
27
``` sh
28
- npm install obs-websocket-js --save
28
+ npm install @duncte123/ obs-websocket-js --save
29
29
30
- bower install obs-websocket-js --save
30
+ bower install @duncte123/ obs-websocket-js --save
31
31
```
32
32
33
33
Typescript definitions are included in this package, and are automatically generated to match the latest ` obs-websocket ` release.
@@ -43,13 +43,13 @@ The web distributable exposes a global named `OBSWebSocket`.
43
43
In node...
44
44
45
45
``` js
46
- const OBSWebSocket = require (' obs-websocket-js' );
46
+ const OBSWebSocket = require (' @duncte123/ obs-websocket-js' );
47
47
```
48
48
49
49
If you're working in a frontend framework and want to use static imports...
50
50
51
51
``` js
52
- import OBSWebSocket from ' ../../node_modules/obs-websocket-js/lib/OBSWebSocket.js' ; // relative path may vary depending on location of node_modules directory
52
+ import OBSWebSocket from ' ../../node_modules/@duncte123/ obs-websocket-js/lib/OBSWebSocket.js' ; // relative path may vary depending on location of node_modules directory
53
53
```
54
54
55
55
Create a new WebSocket connection using the following.
@@ -115,7 +115,7 @@ obs.on('error', err => {
115
115
#### Example
116
116
See more examples in [ ` \samples ` ] ( samples ) .
117
117
``` js
118
- const OBSWebSocket = require (' obs-websocket-js' );
118
+ const OBSWebSocket = require (' @duncte123/ obs-websocket-js' );
119
119
120
120
const obs = new OBSWebSocket ();
121
121
obs .connect ({
@@ -238,20 +238,23 @@ _To add your project to this list, submit a Pull Request._
238
238
239
239
240
240
241
- [ badge-build-status ] : https://img.shields.io/travis/haganbmj/obs-websocket-js/master.svg?style=flat " Travis Status "
242
- [ badge-tag ] : https://img.shields.io/github/tag/haganbmj/obs-websocket-js.svg?style=flat " Latest Tag "
243
- [ badge-release ] : https://img.shields.io/github/release/haganbmj/obs-websocket-js.svg?style=flat " Latest Release "
244
- [ badge-coveralls ] : https://coveralls.io/repos/github/haganbmj/obs-websocket-js/badge.svg?branch=master " Coveralls Status "
245
- [ badge-npm-downloads ] : https://img.shields.io/npm/dt/obs-websocket-js.svg " NPM Downloads "
241
+ [ badge-build-status ] : https://img.shields.io/github/workflow/status/duncte123/obs-websocket-js/Node.js%20CI/master.svg?style=flat " Build Status "
242
+ [ badge-tag ] : https://img.shields.io/github/tag/duncte123/obs-websocket-js.svg?style=flat " Latest Tag "
243
+ [ badge-release ] : https://img.shields.io/github/release/duncte123/obs-websocket-js.svg?style=flat " Latest Release "
244
+ [ badge-coveralls ] : https://coveralls.io/repos/github/duncte123/obs-websocket-js/badge.svg?branch=master " Coveralls Status "
245
+ [ badge-npm-downloads ] : https://img.shields.io/npm/dt/@duncte123/obs-websocket-js.svg?style=flat " NPM Downloads "
246
+ [ badge-npm-version ] : https://img.shields.io/npm/v/@duncte123/obs-websocket-js.svg?style=flat " NPM Version "
247
+ [ badge-npm-license ] : https://img.shields.io/npm/l/@duncte123/obs-websocket-js.svg?style=flat " NPM Version "
246
248
247
249
[ link-obswebsocket ] : https://github.com/Palakis/obs-websocket " OBS WebSocket Plugin "
248
- [ link-Travis-CI ] : https://travis-ci.org/haganbmj/obs-websocket-js " Travis CI "
250
+ [ link-npm ] : https://www.npmjs.com/package/@duncte123/obs-websocket-js " Npm "
251
+ [ link-Travis-CI ] : https://travis-ci.org/duncte123/obs-websocket-js " Travis CI "
249
252
[ link-Coveralls ] : https://coveralls.io/github/haganbmj/obs-websocket-js?branch=master " Coveralls "
250
- [ link-releases ] : https://github.com/haganbmj /obs-websocket-js/releases " obs-websocket-js Releases "
251
- [ link-tags ] : https://github.com/haganbmj /obs-websocket-js/tags " obs-websocket-js Tags "
252
- [ link-download ] : https://raw.githubusercontent.com/haganbmj /obs-websocket-js/gh-pages/dist/obs-websocket.js " Download "
253
- [ link-documentation ] : https://github.com/haganbmj /obs-websocket-js/blob/gh-pages/DOCUMENTATION.md " Documentation "
254
- [ link-samples ] : https://github.com/haganbmj /obs-websocket-js/tree/master/samples " Samples "
255
- [ link-changelog ] : https://github.com/haganbmj /obs-websocket-js/blob/gh-pages/CHANGELOG.md " Changelog "
253
+ [ link-releases ] : https://github.com/duncte123 /obs-websocket-js/releases " obs-websocket-js Releases "
254
+ [ link-tags ] : https://github.com/duncte123 /obs-websocket-js/tags " obs-websocket-js Tags "
255
+ [ link-download ] : https://raw.githubusercontent.com/duncte123 /obs-websocket-js/gh-pages/dist/obs-websocket.js " Download "
256
+ [ link-documentation ] : https://github.com/duncte123 /obs-websocket-js/blob/gh-pages/DOCUMENTATION.md " Documentation "
257
+ [ link-samples ] : https://github.com/duncte123 /obs-websocket-js/tree/master/samples " Samples "
258
+ [ link-changelog ] : https://github.com/duncte123 /obs-websocket-js/blob/gh-pages/CHANGELOG.md " Changelog "
256
259
[ link-contributing ] : .github/CONTRIBUTING.md " Contributing "
257
260
[ link-debug ] : https://github.com/visionmedia/debug " Debug Documentation "
0 commit comments