2929 </a >
3030</p >
3131<p align =" center " >
32- A pure Rust implementation of WebRTC stack. Rewrite < a href = " http://Pion.ly " >Pion</ a > WebRTC stack in Rust
32+ Async-friendly WebRTC implementation in Rust
3333</p >
3434
3535<p align =" center " >
@@ -59,21 +59,23 @@ alt="Recall.ai">
5959- [ Overview] ( #overview )
6060- [ Features] ( #features )
6161- [ Building] ( #building )
62- - [ Toolchain] ( #toolchain )
63- - [ Monorepo Setup] ( #monorepo-setup )
6462- [ Open Source License] ( #open-source-license )
6563- [ Contributing] ( #contributing )
6664
6765</details >
6866
6967## Overview
7068
71- WebRTC.rs is a pure Rust implementation of WebRTC stack, which
72- rewrites <a href =" https://github.com/pion/webrtc/releases/tag/v3.1.5 " >Pion</a > stack in Rust.
73- This project is still in active and early development stage, please refer to
74- the [ Roadmap] ( https://github.com/webrtc-rs/webrtc/issues/1 ) to track the major milestones and releases.
75- [ Examples] ( https://github.com/webrtc-rs/webrtc/blob/master/examples/examples/README.md ) provide code samples to show how
76- to use webrtc-rs to build media and data channel applications.
69+ WebRTC.rs is an async-friendly WebRTC implementation in Rust, originally inspired by and largely rewriting the Pion
70+ stack. The project is under active development and should be considered early stage; please refer to the
71+ [ Roadmap] ( https://github.com/webrtc-rs/webrtc/issues/1 ) for planned milestones and releases.
72+ The [ Examples] ( https://github.com/webrtc-rs/webrtc/blob/master/examples/examples/README.md ) demonstrate how to build
73+ media and data-channel applications using webrtc-rs.
74+
75+ The project is shifting its focus toward a Sans-IO WebRTC implementation in Rust.
76+ Going forward, the [ webrtc-rs/webrtc] ( https://github.com/webrtc-rs/webrtc ) crate will be built on top of the
77+ [ webrtc-rs/rtc] ( https://github.com/webrtc-rs/rtc ) crate, which provides a clean, protocol-centric Sans-IO core.
78+ This architecture enables a fully async-friendly WebRTC implementation in Rust.
7779
7880## Features
7981
@@ -108,19 +110,6 @@ to use webrtc-rs to build media and data channel applications.
108110
109111## Building
110112
111- ### Toolchain
112-
113- ** Minimum Supported Rust Version:** ` 1.65.0 `
114-
115- Our minimum supported rust version(MSRV) policy is to support versions of the compiler released within the last six
116- months. We don't eagerly bump the minimum version we support, instead the minimum will be bumped on a needed by needed
117- basis, usually because downstream dependencies force us to.
118-
119- ** Note:** Changes to the minimum supported version are not consider breaking from a [ semver] ( https://semver.org/ )
120- perspective.
121-
122- ### Monorepo Setup
123-
124113All webrtc dependent crates and examples are included in this repository at the top level in a Cargo workspace.
125114
126115To build all webrtc examples:
@@ -141,29 +130,6 @@ To build webrtc crate:
141130cargo build [or clippy or test or fmt]
142131```
143132
144- ### Devbox
145-
146- This repo now supports [ devbox] ( https://www.jetify.com/devspace ) for a better development experience.
147- In short, devbox allows to define a development environment by modifying the ` PATH ` variable in your shell.
148- It is based on nix and runs on Linux, MacOS, and WSL.
149- To use devbox, install it from [ devbox installation] ( https://www.jetify.com/docs/devbox/installing_devbox/ ) :
150-
151- ``` bash
152- curl -fsSL https://get.jetify.com/devbox | bash
153- ```
154-
155- Now you can either use the different devbox scripts:
156-
157- - test it: ` devbox run test `
158- - build it: ` devbox run build `
159- - format it: ` devbux run format `
160-
161- Or you can enter a shell with everything pre-installed:
162-
163- ``` bash
164- devbox shell
165- ```
166-
167133## Open Source License
168134
169135Dual licensing under both MIT and Apache-2.0 is the currently accepted standard by the Rust language community and has
@@ -174,11 +140,3 @@ community standards, webrtc-rs is using the dual MIT+Apache-2.0 license.
174140## Contributing
175141
176142Contributors or Pull Requests are Welcome!!!
177-
178- If you want to contribute, please be sure to install the pre-commit hooks:
179-
180- ``` bash
181- pre-commit install
182- ```
183-
184- Or use the devbox environment described above, which will do so automatically.
0 commit comments