This repository has been archived by the owner on Mar 16, 2022. It is now read-only.
forked from pion/webrtc
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Relates to pion#142
- Loading branch information
Showing
4 changed files
with
80 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| # Contributing | ||
| <h1 align="center"> | ||
| Contributing | ||
| </h1> | ||
|
|
||
| Moved to [https://github.com/pions/webrtc/wiki/Contributing](https://github.com/pions/webrtc/wiki/Contributing) | ||
| Moved to the **[contributing wiki](https://github.com/pions/webrtc/wiki/Contributing)**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,37 @@ | ||
| # Why pion-WebRTC | ||
| <h1 align="center"> | ||
| Design | ||
| </h1> | ||
| WebRTC is a powerful, but complicated technology. You can build amazing things with it comes with a steep learning curve though. | ||
| Using WebRTC in the browser is easy, but outside the browser is more of a challenge. There are multiple libraries, and they all have | ||
| varying levels of quality. Most are also difficult to build, and depend on libraries that aren't available in repos or portable. | ||
|
|
||
| pion-WebRTC aims to solve all that! Built in native Go you should be able to send and receive media and text from anywhere with minimal headache. | ||
| These are the design principals that drive pion-WebRTC and hopefully convince you it is worth a try. | ||
| Pion WebRTC aims to solve all that! Built in native Go you should be able to send and receive media and text from anywhere with minimal headache. | ||
| These are the design principals that drive Pion WebRTC and hopefully convince you it is worth a try. | ||
|
|
||
| ## Portable | ||
| pion-WebRTC is written in Go and extremely portable. Anywhere Golang runs, pion-WebRTC should work as well! Instead of dealing with complicated | ||
| ### Portable | ||
| Pion WebRTC is written in Go and extremely portable. Anywhere Golang runs, Pion WebRTC should work as well! Instead of dealing with complicated | ||
| cross-compiling of multiple libraries, you now can run anywhere with one `go build` | ||
|
|
||
| ## Simple API | ||
| If you know how to use WebRTC in your browser, you know how to use pion-WebRTC. | ||
| ### Simple API | ||
| If you know how to use WebRTC in your browser, you know how to use Pion WebRTC. | ||
| We try our best just to duplicate the Javascript API, so your code can look the same everywhere. | ||
|
|
||
| If this is your first time using WebRTC, don't worry! We have multiple [examples](https://github.com/pions/webrtc/tree/master/examples) and [GoDoc](https://godoc.org/github.com/pions/webrtc) | ||
|
|
||
| ## Bring your own media | ||
| pion-WebRTC doesn't make any assumptions about where your audio, video or text come from. You can use FFmpeg, GStreamer, MLT or just serve a video file. | ||
| ### Bring your own media | ||
| Pion WebRTC doesn't make any assumptions about where your audio, video or text come from. You can use FFmpeg, GStreamer, MLT or just serve a video file. | ||
| This library only serves to transport, not create media. | ||
|
|
||
| ## Safe | ||
| ### Safe | ||
| Golang provides a great foundation to build safe network services. | ||
| Especially when running a networked service that is highly concurrent bugs can be devastating. | ||
|
|
||
| ## Readable | ||
| ### Readable | ||
| If code comes from an RFC we try to make sure everything is commented with a link to the spec. | ||
| This makes learning and debugging easier, this WebRTC library was written to also serve as a guide for others. | ||
|
|
||
| ## Tested | ||
| ### Tested | ||
| Every commit is tested via travis-ci Go provides fantastic facilities for testing, and more will be added as time goes on. | ||
|
|
||
| ## Shared libraries | ||
| ### Shared libraries | ||
| Every pion product is built using shared libraries, allowing others to review and reuse our libraries. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,73 @@ | ||
| # Pion WebRTC | ||
| [](https://travis-ci.org/pions/webrtc) | ||
| [](https://godoc.org/github.com/pions/webrtc) | ||
| [](https://goreportcard.com/report/github.com/pions/webrtc) | ||
| [](https://coveralls.io/github/pions/webrtc) | ||
| [](https://www.codacy.com/app/Sean-Der/webrtc) | ||
| [](LICENSE.md) | ||
|
|
||
| <div align="center"> | ||
| <a href="#"> | ||
| <img src="./.github/pion-gopher-webrtc.png" height="300px"> | ||
| </a> | ||
| </div> | ||
|
|
||
| A Golang implementation of the WebRTC API. | ||
|
|
||
| See [DESIGN.md](DESIGN.md) for the features it offers, and future goals. | ||
|
|
||
| ## Getting Started | ||
| This project provides a Go implementation of the WebRTC API. There isn't a application that will fit all your needs, but we provide a | ||
| few simple examples to show common use cases that you are free to modify and extend to your needs. | ||
|
|
||
| ### What can I build with pion-WebRTC? | ||
| pion-WebRTC is here to help you get media/text from A<->B, here are some of the cool things you could build. | ||
|
|
||
| * Send a video file to multiple browser in real time, perfectly synchronized movie watching. | ||
| * Send a webcam on a small device to your browser, with no additional server required | ||
| * Securely send data between two servers, without using pub/sub | ||
| * Record your webcam and do special effects server side | ||
| * Build a conferencing application that processes audio/video and make decisions off of it | ||
|
|
||
| ### Prerequisites | ||
| We still use OpenSSL for DTLS (we are actively working on replacing it) so make sure to install the OpenSSL headers for | ||
| your platform before using pion-WebRTC. | ||
| <h1 align="center"> | ||
| <a href="https://pion.ly"><img src="./.github/pion-gopher-webrtc.png" alt="Pion WebRTC" height="250px"></a> | ||
| <br> | ||
| Pion WebRTC | ||
| <br> | ||
| </h1> | ||
| <h4 align="center">A Golang implementation of the WebRTC API</h4> | ||
| <br> | ||
| <p align="center"> | ||
| <a href="https://travis-ci.org/pions/webrtc"><img src="https://travis-ci.org/pions/webrtc.svg?branch=master" alt="Build Status"></a> | ||
| <a href="https://godoc.org/github.com/pions/webrtc"><img src="https://godoc.org/github.com/pions/webrtc?status.svg" alt="GoDoc"></a> | ||
| <a href="https://goreportcard.com/report/github.com/pions/webrtc"><img src="https://goreportcard.com/badge/github.com/pions/webrtc" alt="Go Report Card"></a> | ||
| <a href="https://coveralls.io/github/pions/webrtc"><img src="https://coveralls.io/repos/github/pions/webrtc/badge.svg" alt="Coverage Status"></a> | ||
| <a href="https://www.codacy.com/app/Sean-Der/webrtc"><img src="https://api.codacy.com/project/badge/Grade/18f4aec384894e6aac0b94effe51961d" alt="Codacy Badge"></a> | ||
| <a href="LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a> | ||
| </p> | ||
| <br> | ||
|
|
||
| See [DESIGN.md](DESIGN.md) for an overview of features and future goals. | ||
|
|
||
| ### Install | ||
| Currently Pion uses CGO and OpenSSL for DTLS. We are actively working on replacing it. For now you have to make sure to install a C compliler and the OpenSSL headers for | ||
| your platform: | ||
| #### Ubuntu/Debian | ||
| `sudo apt-get install libssl-dev` | ||
|
|
||
| #### OSX | ||
|
|
||
| ``` | ||
| brew install openssl | ||
| export CPATH=`brew --prefix`/opt/openssl/include | ||
| export LIBRARY_PATH=`brew --prefix`/opt/openssl/lib | ||
| go get -u github.com/pions/webrtc | ||
| ``` | ||
|
|
||
| #### Fedora | ||
| `sudo yum install openssl-devel` | ||
|
|
||
| #### Windows | ||
| 1. Install [mingw-w64](http://mingw-w64.sourceforge.net/) | ||
| 2. Install [pkg-config-lite](http://sourceforge.net/projects/pkgconfiglite) | ||
| 3. Build (or install precompiled) openssl for mingw32-w64 | ||
| 4. Set __PKG\_CONFIG\_PATH__ to the directory containing openssl.pc | ||
| (i.e. c:\mingw64\mingw64\lib\pkgconfig) | ||
|
|
||
| ### Example Programs | ||
| Examples for common use cases, extend and modify to quickly get started. | ||
| * [gstreamer-receive](examples/gstreamer-receive/README.md) Play video and audio from your Webcam live using GStreamer | ||
| * [gstreamer-send](examples/gstreamer-send/README.md) Send video generated from GStreamer to your browser | ||
| * [save-to-disk](examples/save-to-disk/README.md) Save video from your Webcam to disk | ||
| * [data-channels](examples/data-channels/README.md) Use DataChannels to send text between pion-WebRTC and your browser | ||
| ### Usage | ||
| Check out the **[example applications](examples/README.md)** to help you along your Pion WebRTC journey. | ||
|
|
||
| The Pion WebRTC API closely matches the JavaScript **[WebRTC API](https://w3c.github.io/webrtc-pc/)**. Most existing documentation is therefore also usefull when working with Pion. Furthermore, our **[GoDoc](https://godoc.org/github.com/pions/webrtc)** is actively maintained. | ||
|
|
||
| ### Writing your own application | ||
| The API should match the Javascript WebRTC API, and the [GoDoc](https://godoc.org/github.com/pions/webrtc) is actively maintained | ||
| Now go forth and build some awesome apps! Here are some **ideas** to get your creative juices flowing: | ||
| * Send a video file to multiple browser in real time for perfectly synchronized movie watching. | ||
| * Send a webcam on an embedded device to your browser with no additional server required! | ||
| * Securely send data between two servers, without using pub/sub. | ||
| * Record your webcam and do special effects server side. | ||
| * Build a conferencing application that processes audio/video and make decisions off of it. | ||
|
|
||
| ## Roadmap | ||
| pion-WebRTC is in active development, you can find the roadmap [here](https://github.com/pions/webrtc/issues/9). | ||
| ### Roadmap | ||
| The library is in active development, please refer to the [roadmap](https://github.com/pions/webrtc/issues/9) to track our major milestones. | ||
|
|
||
| ## Questions/Support | ||
| Sign up for the [Golang Slack](https://invite.slack.golangbridge.org/) and join the #pion channel for discussions and support | ||
| ### Community | ||
| Pion has an active community on the [Golang Slack](https://invite.slack.golangbridge.org/). Sign up and join the **#pion** channel for discussions and support. You can also use [Pion mailing list](https://groups.google.com/forum/#!forum/pion). | ||
|
|
||
| You can also use [Pion mailing list](https://groups.google.com/forum/#!forum/pion) | ||
| We are always looking to support **your projects**. Please reach out if you have something to build! | ||
|
|
||
| If you need commercial support/don't want to use public methods you can contact us at [[email protected]](mailto:[email protected]) | ||
| If you need commercial support or don't want to use public methods you can contact us at [[email protected]](mailto:[email protected]) | ||
|
|
||
| ## Contributing | ||
| See [Contributing](https://github.com/pions/webrtc/wiki/Contributing) | ||
| ### Related projects | ||
| * [pions/turn](https://github.com/pions/turn): A simple extendable Golang TURN server | ||
| * [WIP] [pions/media-server](https://github.com/pions/media-server): A Pion WebRTC powered media server, providing the building blocks for anything RTC. | ||
| * [WIP] [pions/dcnet](https://github.com/pions/dcnet): A package providing Golang [net](https://godoc.org/net) interfaces around Pion WebRTC data channels. | ||
|
|
||
| ### Contributors | ||
| ### Contributing | ||
| Check out the **[contributing wiki](https://github.com/pions/webrtc/wiki/Contributing)** to join the group of amazing people making this project possible: | ||
|
|
||
| * [John Bradley](https://github.com/kc5nra) - *Original Author* | ||
| * [Michael Melvin Santry](https://github.com/santrym) - *Mascot* | ||
|
|
@@ -91,14 +81,5 @@ See [Contributing](https://github.com/pions/webrtc/wiki/Contributing) | |
| * [wattanakorn495](https://github.com/wattanakorn495) | ||
| * [Max Hawkins](https://github.com/maxhawkins) - *RTCP* | ||
|
|
||
|
|
||
| ## Project Ideas | ||
| We are looking to support other interesting WebRTC projects, so if you have something to build please reach out! | ||
| pion-WebRTC would make a great foundation for. | ||
|
|
||
| * Easy language bindings (Python) | ||
| * Golang SFU | ||
| * Server side processing (video effects or an MCU) | ||
|
|
||
| ## License | ||
| ### License | ||
| MIT License - see [LICENSE.md](LICENSE.md) for full text | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters