Skip to content

Commit a3fbdf8

Browse files
author
QuasarStream Team
committed
update -> about commit history
1 parent cc3746b commit a3fbdf8

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@
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+
### Please Note:
9+
10+
We've been working on this repository and many other PHP WebRTC-related ones
11+
(**such as ICE, RTP, RTCP, and more than 22 others**)
12+
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**).
13+
Originally, there was a long commit history that reflected all our work.
14+
15+
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.
16+
17+
**Removing the history helps us keep that information private and stay a bit safer from potential security risks.**
18+
19+
820
## Features
921

1022
- Full peer-to-peer WebRTC stack in native PHP
@@ -22,6 +34,11 @@ This package provides a complete WebRTC implementation written entirely in PHP,
2234
- OpenSSL development libraries
2335
- Srtp development libraries
2436
- Linux environment (Windows/macOS support planned)
37+
- **Windows users:** Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) or Docker Desktop.
38+
*Note: Native Windows support is planned for an upcoming releases (in a few months.).*
39+
40+
- **macOS users:** Use an emulator like [UTM](https://mac.getutm.app/) or run the project using Docker.
41+
*Note: Native macOS support is coming in a few months.*
2542
- FFmpeg/libav shared libraries (libavcodec, libavfilter, etc.)
2643
- Compatible with FFmpeg **version 7.1.1**
2744
- libopus development libraries
@@ -44,19 +61,22 @@ This package is part of the PHP WebRTC library. For complete documentation, exam
4461

4562
- **Sana Moniri**
4663
- GtiHub: [sanamoniri](https://github.com/sanamoniri)
64+
Got it! Here's the revised version without em dashes and with a natural tone:
4765

4866
## Reporting Issues
4967

5068
Found a bug? Please report it on our [issues](https://github.com/php-webrtc/webrtc/issues).
5169

70+
## Contributors
71+
72+
Your contribution is crucial to our success, regardless of its size. We appreciate your support and encourage you to
73+
read our **[CONTRIBUTING](https://github.com/php-webrtc/webrtc/blob/master/CONTRIBUTING.md)**
74+
guide for detailed instructions on how to get involved. Together, we can make a significant impact.
75+
5276
## License
5377

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

5680
## References
5781

5882
- [WebRTC Overview](https://webrtc.org/)
59-
- [RFC 8829 – WebRTC API](https://datatracker.ietf.org/doc/html/rfc8829)
60-
- [RFC 5245 – ICE](https://datatracker.ietf.org/doc/html/rfc5245)
61-
- [RFC 5763 – DTLS-SRTP](https://datatracker.ietf.org/doc/html/rfc5763)
62-
- [RFC 8831 – Data Channels](https://datatracker.ietf.org/doc/html/rfc8831)

0 commit comments

Comments
 (0)