Skip to content

Commit 4e94284

Browse files
author
TinaTiel
authored
docs: Update to mirror develop readme
- was missing eol notice for 1.X - corrected typo
1 parent 1e289af commit 4e94284

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11

22
# websocket-obs-java
33
### A java library for the [**OBS-Studio websocket plugin**](https://github.com/Palakis/obs-websocket) by [**Palakis**](https://github.com/Palakis).
4+
5+
---
6+
7+
## Notice: Last 1.X.X Release! Stay Tuned for 2.0.0...
8+
As announced for the Palakis OBS Websocket plugin, Release 4.9.1 will be its last release before 5.X.X. The next major release will introduce breaking changes, overhauling its protocol to make room for many improvements.
9+
10+
For us, this means we will focus on updating this library so that it is compatible. We will also do a small overhaul ourselves to improve maintainability (addressing serialization boilerplate, and lifecycle management).
11+
12+
The next release for websocket-obs-java will be 2.0.0, and all further work on the `develop` branch (at version 1.3.0) will stop, except for major bugs/issues. Like the 5.X.X release for Palakis, ours will also introduce breaking changes.
13+
14+
You can view the release notes for 1.3.0 [here](https://github.com/Twasi/websocket-obs-java/pull/44).
15+
416
---
517
## Getting started
618

@@ -11,7 +23,7 @@ First include the library in your project using Maven:
1123
<dependency>
1224
<groupId>net.twasi</groupId>
1325
<artifactId>obs-websocket-java</artifactId>
14-
<version>1.2.0</version>
26+
<version>1.3.0</version> <!-- Last Obs Websocket 4.X.X Compatible Release -->
1527
</dependency>
1628
```
1729

@@ -100,7 +112,7 @@ binding you want (depends on the vendor)
100112
If you miss an endpoint feel free to make a pull request. Any help is appreciated.
101113

102114
### 📘 Notice to Developers: Repository Transfer 📘
103-
On June 21st, 2021, this repository was transferred from the `Twasi` personal account to the
115+
On June 21st, 2021, this repository was transferred from the `Twasi` Organization to the
104116
`obs-websocket-community-projects` Organization. This was done to better align this library with the
105117
greater Palakis' OBS Websocket plugin community, and provide better administrative tools.
106118

@@ -124,6 +136,7 @@ origin https://github.com/obs-websocket-community-projects/websocket-obs-java.g
124136
See [Transferring a repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/transferring-a-repository)
125137
for more information.
126138

139+
127140
### Building
128141

129142
If you've forked the repository and want to run the install goal to use your fork in your own project, please be aware

0 commit comments

Comments
 (0)