You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-11
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ obs-websocket-js allows Javascript-based connections to the Open Broadcaster Sof
24
24
25
25
# Version Warning!
26
26
27
-
> You are currently reading the documentation for upcoming v5. [For v4 documentation look here](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4)
27
+
> You are currently reading the documentation for v5. [For v4 documentation look here](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4)
28
28
29
29
---
30
30
@@ -35,14 +35,18 @@ obs-websocket-js allows Javascript-based connections to the Open Broadcaster Sof
35
35
Using a package manager like npm / yarn is the recommended installation method when you're planning to use obs-websocket-js in node.js, building a web app that you'll bundle with webpack or rollup, or for using type definitions.
36
36
37
37
```sh
38
-
npm install obs-websocket-js@next
39
-
```
40
-
or
41
-
```sh
42
-
yarn add obs-websocket-js@next
38
+
npm install obs-websocket-js
39
+
yarn add obs-websocket-js
43
40
```
44
41
45
-
> Until obs-websocket 5.0 is released, the client supporting 5.x is released under next tag
42
+
### Standalone file / CDN build
43
+
44
+
Standalone js file is available from [the latest github release](https://github.com/obs-websocket-community-projects/obs-websocket-js/releases) or from jsdeliver & unpkg CDN's:
45
+
46
+
```
47
+
https://cdn.jsdelivr.net/npm/obs-websocket-js
48
+
https://unpkg.com/obs-websocket-js
49
+
```
46
50
47
51
## Usage
48
52
@@ -297,13 +301,12 @@ For more information, see the [`debug`](https://github.com/visionmedia/debug) pa
297
301
298
302
## Upgrading
299
303
300
-
* Upgrading from 4.x to 5.x (available soon)
304
+
*[Upgrading from 4.x to 5.x](https://github.com/obs-websocket-community-projects/obs-websocket-js/releases/tag/v5.0.0)
301
305
*[Upgrading from 2.x to 3.x](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4#upgrading-from-2x-to-3x)
302
306
*[Upgrading from 1.x to 2.x](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4#upgrading-from-1x-to-2x)
303
307
304
308
## Projects Using **obs-websocket-js**
305
-
_To add your project to this list, submit a Pull Request._
0 commit comments