Skip to content

Commit

Permalink
Add breaking changes notice to README.md
Browse files Browse the repository at this point in the history
Hopefully this will make v2 breaking changes less
confusing for people who have projects tracking HEAD.
  • Loading branch information
maxhawkins authored and Sean-Der committed Feb 19, 2019
1 parent 31fa14c commit ad647c2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@

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

### Breaking Changes

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.

Have any questions? Join [the Slack channel](https://gophers.slack.com/messages/pion) to follow development and speak with the maintainers.

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.

### Usage
Check out the **[example applications](examples/README.md)** to help you along your Pion WebRTC journey.

Expand Down

0 comments on commit ad647c2

Please sign in to comment.