summaryrefslogtreecommitdiff
path: root/vendor/github.com/pion/srtp/v2/README.md
blob: 19551e35ed03f4646776347740a7d201cd796cdc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<h1 align="center">
  <br>
  Pion SRTP
  <br>
</h1>
<h4 align="center">A Go implementation of SRTP</h4>
<p align="center">
  <a href="https://pion.ly"><img src="https://img.shields.io/badge/pion-srtp-gray.svg?longCache=true&colorB=brightgreen" alt="Pion SRTP"></a>
  <a href="https://sourcegraph.com/github.com/pion/srtp?badge"><img src="https://sourcegraph.com/github.com/pion/srtp/-/badge.svg" alt="Sourcegraph Widget"></a>
  <a href="https://pion.ly/slack"><img src="https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen" alt="Slack Widget"></a>
  <br>
  <a href="https://travis-ci.org/pion/srtp"><img src="https://travis-ci.org/pion/srtp.svg?branch=master" alt="Build Status"></a>
  <a href="https://pkg.go.dev/github.com/pion/srtp"><img src="https://godoc.org/github.com/pion/srtp?status.svg" alt="GoDoc"></a>
  <a href="https://codecov.io/gh/pion/srtp"><img src="https://codecov.io/gh/pion/srtp/branch/master/graph/badge.svg" alt="Coverage Status"></a>
  <a href="https://goreportcard.com/report/github.com/pion/srtp"><img src="https://goreportcard.com/badge/github.com/pion/srtp" alt="Go Report Card"></a>
  <a href="LICENSE"><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.

### Roadmap
The library is used as a part of our WebRTC implementation. Please refer to that [roadmap](https://github.com/pion/webrtc/issues/9) to track our major milestones.

### 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).

We are always looking to support **your projects**. Please reach out if you have something to build!

If you need commercial support or don't want to use public methods you can contact us at [team@pion.ly](mailto:team@pion.ly)

### Contributing
Check out the **[contributing wiki](https://github.com/pion/webrtc/wiki/Contributing)** to join the group of amazing people making this project possible:

* [Sean DuBois](https://github.com/Sean-Der) - *Original Author*
* [Michiel De Backker](https://github.com/backkem) - *io.Writer interfaces*
* [Tobias Fridén](https://github.com/tobiasfriden) *SRTP authentication verification*
* [chenkaiC4](https://github.com/chenkaiC4) - *Fix GolangCI Linter*
* [Luke Curley](https://github.com/kixelated) - *Performance*
* [Chris Hiszpanski](https://github.com/thinkski) - *Fix out-of-bounds access*
* [Yutaka Takeda](https://github.com/enobufs) - *Fix log messages*
* [Max Hawkins](https://github.com/maxhawkins)
* [Woodrow Douglass](https://github.com/wdouglass)
* [Hugo Arregui](https://github.com/hugoArregui)
* [Atsushi Watanabe](https://github.com/at-wat)
* [Novel Corpse](https://github.com/NovelCorpse)
* [Jerko Steiner](https://github.com/jeremija)
* [Juliusz Chroboczek](https://github.com/jech)
* [Mission Liao](https://github.com/mission-liao)
* [Orlando](https://github.com/OrlandoCo)
* [Tarrence van As](https://github.com/tarrencev)

### License
MIT License - see [LICENSE](LICENSE) for full text