Skip to content

Commit 593a26e

Browse files
committed
Update readme for v5 release
1 parent 1a20a48 commit 593a26e

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ obs-websocket-js allows Javascript-based connections to the Open Broadcaster Sof
2424

2525
# Version Warning!
2626

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)
2828
2929
---
3030

@@ -35,14 +35,18 @@ obs-websocket-js allows Javascript-based connections to the Open Broadcaster Sof
3535
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.
3636

3737
```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
4340
```
4441

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+
```
4650

4751
## Usage
4852

@@ -297,13 +301,12 @@ For more information, see the [`debug`](https://github.com/visionmedia/debug) pa
297301

298302
## Upgrading
299303

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)
301305
* [Upgrading from 2.x to 3.x](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4#upgrading-from-2x-to-3x)
302306
* [Upgrading from 1.x to 2.x](https://github.com/obs-websocket-community-projects/obs-websocket-js/tree/v4#upgrading-from-1x-to-2x)
303307

304308
## Projects Using **obs-websocket-js**
305-
_To add your project to this list, submit a Pull Request._
306-
- [GamesDoneQuick/agdq17-layouts](https://github.com/GamesDoneQuick/agdq17-layouts)
307-
- [nodecg/nodecg-obs](https://github.com/nodecg/nodecg-obs)
309+
310+
[Share your project in github discussions!](https://github.com/obs-websocket-community-projects/obs-websocket-js/discussions/categories/show-and-tell)
308311

309312
## [Contributing Guidelines](.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)