From c02a66202fb90fa7342f409c31afc868cf849918 Mon Sep 17 00:00:00 2001 From: Rob Watson Date: Wed, 23 Apr 2025 06:44:02 +0200 Subject: [PATCH] doc: update README --- CONTRIBUTING.md | 11 ++++++----- README.md | 11 ++++------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b91b3ca..2e626ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,11 +33,12 @@ broadcast to localhost:1935 or localhost:1936. ## 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. 1. Fork the repo -2. Make your changes, including test coverage -3. Push the changes to a branch -4. Ensure the branch is passing -5. Open a pull request +1. Make your changes, including test coverage +1. Run the formatter (`mise run format`) +1. Push the changes to a branch +1. Ensure the branch is passing +1. Open a pull request diff --git a/README.md b/README.md index 19d85a5..6888e9c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![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) -Octoplex is a live video restreamer for the terminal. +Octoplex is a Docker-native live video restreamer. * Restream RTMP/RTMPS to unlimited destinations * Broadcast using OBS or any standard tool @@ -38,8 +38,7 @@ Octoplex is a live video restreamer for the terminal. ### Docker Engine -First, make sure Docker Engine is installed. Octoplex uses Docker to manage -FFmpeg and other streaming tools. +First, ensure that Docker Engine is installed. 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 +See [CONTRIBUTING.md](/CONTRIBUTING.md). + ### Bug reports Open bug reports [on GitHub](https://github.com/rfwatson/octoplex/issues/new). -### Pull requests - -Pull requests are welcome. - ## Acknowledgements Octoplex is built on and/or makes use of other free and open source software,