Pion Template

Template for new Pion repositoies

This repo is a template for starting new Pion-related Git repositories.

Steps for creating a new repo

1. Search and replace any occurrence of template in this repo.
2. Add the repo to the pion/.goassets sync workflow
3. Update README
4. Update the repository details:
   • Tags: at least "go", "golang", "pion", ...
   • Description: same as in README
   • URL: https://pion.ly/
   • Disable features "Environments", "Packages"
5. Please make sure the repo has consistent GitHub settings with the other Pion repos:
   • Disable features "Wiki", "Projects", "Discussions", "Sponsorships"
   • Enable feature "Preserve this repository"
   • Only allow rebase merging. Disable squash and merge commits.
   • Enable option "Always suggest updating pull request branches"
   • Enable option "Automatically delete head branches"
   • Make sure the master branch is protected:
     • Enable "Require a pull request before merging"
       • Enable "Require approvals"
       • Set "Require number of approvals before merging" to 1
     • Enable "Require status checks to pass before merging"
     • Enable "Require linear history"

Roadmap

The library is used as a part of our WebRTC implementation. Please refer to that roadmap to track our major milestones.

Community

Pion has an active community on the Slack.

Follow the Pion Twitter for project updates and important WebRTC news.

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 [email protected]

Contributing

Check out the contributing wiki to join the group of amazing people making this project possible

License

MIT License - see LICENSE for full text