diff --git a/README.md b/README.md index d87cd65..6141961 100644 --- a/README.md +++ b/README.md @@ -33,31 +33,29 @@ Octoplex is a Docker-native live video restreamer. ## Installation +### Docker Engine (only if you'll run Octoplex locally) + +Linux: See https://docs.docker.com/engine/install/. + +macOS: https://docs.docker.com/desktop/setup/install/mac-install/ + ### Octoplex #### Homebrew -Octoplex can be installed using Homebrew on MacOS or Linux. +Octoplex can be installed using Homebrew on macOS or Linux. ``` $ brew tap rfwatson/octoplex $ brew install octoplex ``` -#### From Github +#### From GitHub Alternatively, grab the latest build for your platform from the [releases page](https://github.com/rfwatson/octoplex/releases). Unarchive the `octoplex` binary and copy it somewhere in your $PATH. -### Docker Engine - -If you're running Octoplex locally you'll need Docker installed too. - -Linux: See https://docs.docker.com/engine/install/. - -MacOS: https://docs.docker.com/desktop/setup/install/mac-install/ - ## Usage Octoplex can run as a single process (all-in-one), or in separate client/server mode. @@ -73,8 +71,11 @@ Client/server|Want the server on a remote host (e.g., cloud VM) for long-running $ octoplex run ``` -Starts the Octoplex server and terminal UI in one process, right in your local console. This is a great option to get started quickly! -Docker must be running on the same machine. +Starts the Octoplex server and terminal UI in one process, right in your local console. + +This is a great option to get started quickly! + +Note: Docker must be running on the same machine. ### Client/server mode @@ -87,10 +88,10 @@ $ octoplex server start 2. **Connect the client** (from your laptop or any host): ```bash -$ octoplex client # --host my.remotehost.com if on a different host +$ octoplex client start # --host my.remotehost.com if on a different host ``` -Note: `client` is a lightweight TUI, it does not require Docker. +`client` is a lightweight TUI and does not require Docker to be installed. 3. **Stop the server** (and clean up and Docker resources) on the remote host: