From 2d311bf1d7efb689e412535163bed14a07655484 Mon Sep 17 00:00:00 2001
From: Rob Watson <rob@netflux.io>
Date: Thu, 15 May 2025 08:50:40 +0200
Subject: [PATCH] fixup! doc: update README

---
 README.md | 28 +++++++++++++++++-----------
 1 file changed, 17 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 76b8129..eca6796 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,7 @@ Alternatively, grab the latest build for your platform from the [releases page](
 
 Unarchive the `octoplex` binary and copy it somewhere in your $PATH.
 
-## Usage
+## Starting Octoplex
 
 Octoplex can run as a single process (all-in-one), or in a client/server pair.
 
@@ -97,6 +97,22 @@ $ octoplex client start # --host my.remotehost.com if on a different host
 $ octoplex server stop
 ```
 
+### Subcommand reference
+
+Subcommand|Description
+---|---
+None|Launch the terminal user interface
+`run`|Run Octoplex in all-in-one mode
+`server start`|Start the Octoplex server
+`server stop`|Stop the Octoplex server
+`client start`|Start the Octoplex TUI client
+`server print-config`|Echo the path to the configuration file to STDOUT
+`server edit-config`|Edit the configuration file in $EDITOR
+`version`|Print the version
+`help`|Print help screen
+
+## Usage
+
 ### Restreaming with OBS
 
 #### RTMP
@@ -135,16 +151,6 @@ $ ffmpeg -i input.mp4 -c copy -f flv rtmp://localhost:1935/live
 $ ffmpeg -i input.mp4 -c copy -f flv rtmps://localhost:1936/live
 ```
 
-### Subcommands
-
-Subcommand|Description
----|---
-None|Launch the terminal user interface
-`print-config`|Echo the path to the configuration file to STDOUT
-`edit-config`|Edit the configuration file in $EDITOR
-`version`|Print the version
-`help`|Print help screen
-
 ### Configuration
 
 Octoplex stores configuration state in a simple YAML file. (See [above](#subcommands) for its location.)