Skip to content

Commit 8b023cb

Browse files
author
QuasarStream Team
committed
update README.md
1 parent 40d2aec commit 8b023cb

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

README.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,6 @@
55

66
This package provides a complete WebRTC implementation written entirely in PHP, including support for ICE, DTLS, SRTP, SCTP, RTP, and data channels. Designed for real-time audio, video, and data communication, it enables peer-to-peer connectivity without relying on external WebRTC libraries. Built with modular components and fully asynchronous using ReactPHP.
77

8-
### Our Plans for the Future
9-
We are not stopping here. We're actively continuing development on the PHP WebRTC packages.
10-
11-
Right now, we're working privately on a **[Selective Forwarding Unit (SFU)](https://getstream.io/resources/projects/webrtc/architectures/sfu/)** implementation and a **Laravel package that bundles everything together**, including this WebRTC package. Once that's ready, our goal is to build a **minimal video conferencing web** app using Laravel, and to continue maintaining this repository along with 24 other related packages.
12-
13-
If you're interested in building real-time communication tools in PHP, like a video conferencing app, you are more than welcome to join the project. Fork the repos, contribute to them, and help grow this community.
14-
15-
Please note: contributions should primarily focus on fixing bugs. If you'd like to add a new feature or function, it must match the original WebRTC API behavior. For example, if you want to add a method to the **[`RTCPeerConnection`](https://github.com/PHP-WebRTC/webrtc/blob/master/src/RTCPeerConnection.php)** class, it should exist in the original **[JavaScript WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)** and follow the same naming and purpose.
16-
17-
### Want to Collaborate?
18-
If you'd like to become a contributor or teammate, we’d love to hear from you. This is an open source, non-profit project, so we’re mainly looking for passionate developers.
19-
20-
You should have at least one project that demonstrates your knowledge and ability in PHP,
21-
Laravel, and WebRTC(only one of them is also enough).
22-
If that sounds like you, this could be a great place to get involved.
23-
24-
Feel free to reach out by email(via github@aminyazdanpanah.com) with your GitHub username (for example: github.com/your-username) and we’ll get back to you soon.
25-
26-
### About Git History
27-
We've been working on this repository and many other PHP WebRTC-related ones
28-
(**such as ICE, RTP, RTCP, and more than 22 others**)
29-
for a long time privately(in our git server) before making them open source(**We released our packages only after they have been fully tested and thoroughly debugged**).
30-
Originally, there was a long commit history that reflected all our work.
31-
32-
However, we decided to **remove that history** in the initial public commit to **protect our privacy**. The original commits included details like our **working hours based on commit times and counts**, as well as our **personal email addresses**, which we did not feel comfortable sharing publicly.
33-
34-
**Removing the history helps us keep that information private and stay a bit safer from potential security risks.**
35-
36-
378
## Features
389

3910
- Full peer-to-peer WebRTC stack in native PHP
@@ -89,6 +60,36 @@ Your contribution is crucial to our success, regardless of its size. We apprecia
8960
read our **[CONTRIBUTING](https://github.com/php-webrtc/webrtc/blob/master/CONTRIBUTING.md)**
9061
guide for detailed instructions on how to get involved. Together, we can make a significant impact.
9162

63+
64+
### Our Plans for the Future
65+
We are not stopping here. We're actively continuing development on the PHP WebRTC packages.
66+
67+
Right now, we're working privately on a **[Selective Forwarding Unit (SFU)](https://getstream.io/resources/projects/webrtc/architectures/sfu/)** implementation and a **Laravel package that bundles everything together**, including this WebRTC package. Once that's ready, our goal is to build a **minimal video conferencing web** app using Laravel, and to continue maintaining this repository along with 24 other related packages.
68+
69+
If you're interested in building real-time communication tools in PHP, like a video conferencing app, you are more than welcome to join the project. Fork the repos, contribute to them, and help grow this community.
70+
71+
Please note: contributions should primarily focus on fixing bugs. If you'd like to add a new feature or function, it must match the original WebRTC API behavior. For example, if you want to add a method to the **[`RTCPeerConnection`](https://github.com/PHP-WebRTC/webrtc/blob/master/src/RTCPeerConnection.php)** class, it should exist in the original **[JavaScript WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)** and follow the same naming and purpose.
72+
73+
### Want to Collaborate?
74+
If you'd like to become a contributor or teammate, we’d love to hear from you. This is an open source, non-profit project, so we’re mainly looking for passionate developers.
75+
76+
You should have at least one project that demonstrates your knowledge and ability in PHP,
77+
Laravel, and WebRTC(only one of them is also enough).
78+
If that sounds like you, this could be a great place to get involved.
79+
80+
Feel free to reach out by email(via github@aminyazdanpanah.com) with your GitHub username (for example: github.com/your-username) and we’ll get back to you soon.
81+
82+
### About Git History
83+
We've been working on this repository and many other PHP WebRTC-related ones
84+
(**such as ICE, RTP, RTCP, and more than 22 others**)
85+
for a long time privately(in our git server) before making them open source(**We released our packages only after they have been fully tested and thoroughly debugged**).
86+
Originally, there was a long commit history that reflected all our work.
87+
88+
However, we decided to **remove that history** in the initial public commit to **protect our privacy**. The original commits included details like our **working hours based on commit times and counts**, as well as our **personal email addresses**, which we did not feel comfortable sharing publicly.
89+
90+
**Removing the history helps us keep that information private and stay a bit safer from potential security risks.**
91+
92+
9293
## License
9394

9495
BSD 3-Clause License. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)