Skip to content

Commit 6f83e44

Browse files
committed
update readme to sfu
1 parent 472add7 commit 6f83e44

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# @pulsebeam/client
2+
3+
Simplifies real-time application development. Defines signaling protocol for connection establishment, handling media and data transmission, and provides infrastructure.
4+
5+
## Status
6+
7+
> [!WARNING]
8+
> This SDK is currently in active development. We're currently brewing a homegrown WebRTC SFU implementation in Rust, https://github.com/pulseBeamDev/pulsebeam.
9+
>
10+
> [Create GitHub Issues](https://github.com/PulseBeamDev/pulsebeam-js/issues)
11+
> [Join PulseBeam Developer Discord](https://discord.gg/Bhd3t9afuB)
12+
13+
## Roadmap
14+
15+
The project is in active development, please refer to the [roadmap](https://github.com/PulseBeamDev/pulsebeam-js/issues/6) to track our major milestones.
16+
17+
## Semantic Versioning
18+
19+
This project adheres to [Semantic Versioning 2.0.0](https://semver.org/).
20+
21+
* **MAJOR version (X.y.z):** Incompatible API changes.
22+
* **MINOR version (x.Y.z):** Functionality added in a backwards compatible manner.
23+
* **PATCH version (x.y.Z):** Backwards compatible bug fixes.
24+
25+
## WebRTC Resources
26+
27+
For a deeper understanding of WebRTC concepts, consult the official WebRTC documentation:
28+
29+
* https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API
30+
31+
## Related Links
32+
33+
|Name|Link|
34+
|-|-|
35+
|PulseBeam Server|github.com/pulseBeamDev/pulsebeam|
36+
|Client SDK|https://github.com/PulseBeamDev/pulsebeam-js|
37+
|Server SDK|https://github.com/PulseBeamDev/pulsebeam-core|
38+
|FOSS Server|https://github.com/PulseBeamDev/pulsebeam-server-foss|
39+
|Signaling Protocol|https://github.com/PulseBeamDev/pulsebeam-proto|
40+
|Documentation|https://github.com/PulseBeamDev/docs|
41+
|PulseBeam Cloud|https://cloud.pulsebeam.dev|
42+

0 commit comments

Comments
 (0)