Skip to content

Commit ad647c2

Browse files
maxhawkinsSean-Der
authored andcommitted
Add breaking changes notice to README.md
Hopefully this will make v2 breaking changes less confusing for people who have projects tracking HEAD.
1 parent 31fa14c commit ad647c2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222

2323
See [DESIGN.md](DESIGN.md) for an overview of features and future goals.
2424

25+
### Breaking Changes
26+
27+
Pion WebRTC v2.0.0 is coming soon! HEAD will be unstable for the next few weeks as we prepare for the new release. See the [release notes](https://github.com/pions/webrtc/wiki/v2.0.0-Release-Notes) to learn about the new features breaking changes.
28+
29+
Have any questions? Join [the Slack channel](https://gophers.slack.com/messages/pion) to follow development and speak with the maintainers.
30+
31+
Use the tag [v1.2.0](https://github.com/pions/webrtc/tree/v1.2.0) if you'd like to continue using the v1.0 API in the meantime. After v2.0 is released v1.0 will be deprecated and unmaintained.
32+
2533
### Usage
2634
Check out the **[example applications](examples/README.md)** to help you along your Pion WebRTC journey.
2735

0 commit comments

Comments
 (0)