rob/octoplex
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

doc: update README

Browse Source
This commit is contained in:
Rob Watson 2025-04-23 06:44:02 +02:00
parent 4029c66a4a
commit c02a66202f
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -33,11 +33,12 @@ broadcast to localhost:1935 or localhost:1936.
## Opening a pull request ## Opening a pull request
Pull requests are welcome, but please propose significant changes in a Pull requests are welcome, please propose significant changes in a
[discussion](https://github.com/rfwatson/octoplex/discussions) first. [discussion](https://github.com/rfwatson/octoplex/discussions) first.
1. Fork the repo 1. Fork the repo
2. Make your changes, including test coverage 1. Make your changes, including test coverage
3. Push the changes to a branch 1. Run the formatter (`mise run format`)
4. Ensure the branch is passing 1. Push the changes to a branch
5. Open a pull request 1. Ensure the branch is passing
1. Open a pull request

11
README.md
View File

@ -5,7 +5,7 @@
![GitHub Release](https://img.shields.io/github/v/release/rfwatson/octoplex) ![GitHub Release](https://img.shields.io/github/v/release/rfwatson/octoplex)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
Octoplex is a live video restreamer for the terminal. Octoplex is a Docker-native live video restreamer.
* Restream RTMP/RTMPS to unlimited destinations * Restream RTMP/RTMPS to unlimited destinations
* Broadcast using OBS or any standard tool * Broadcast using OBS or any standard tool
@ -38,8 +38,7 @@ Octoplex is a live video restreamer for the terminal.
### Docker Engine ### Docker Engine
First, make sure Docker Engine is installed. Octoplex uses Docker to manage First, ensure that Docker Engine is installed.
FFmpeg and other streaming tools.
Linux: See https://docs.docker.com/engine/install/. Linux: See https://docs.docker.com/engine/install/.
@ -160,14 +159,12 @@ localhost (`127.0.0.1`) or use `0.0.0.0` to bind to all network interfaces.
## Contributing ## Contributing
See [CONTRIBUTING.md](/CONTRIBUTING.md).
### Bug reports ### Bug reports
Open bug reports [on GitHub](https://github.com/rfwatson/octoplex/issues/new). Open bug reports [on GitHub](https://github.com/rfwatson/octoplex/issues/new).
### Pull requests
Pull requests are welcome.
## Acknowledgements ## Acknowledgements
Octoplex is built on and/or makes use of other free and open source software, Octoplex is built on and/or makes use of other free and open source software,