merge(main): sync README wording from GitHub

commit: 7ec1d0a1182620f85ff0af948df3ce54149b000f
author: brice · 14d ago · 2026-10-08 16:29 UTC
merge of: cfa771f + 3cf12ba · diff against the first parent
signature: GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email

1 file · +4 -7

M README.md +4 -7


@@ -12,9 +12,9 @@ Self-hosted container deployment. Push an image, declare an app, deploy it.
12	12
13	13		## What is Gordon?
14	14
15		-	Gordon is a private container registry, an app runtime, and a reverse proxy for your VPS.
	15	+	Gordon is a private image container registry, an app runtime, and a reverse proxy for your VPS.
16	16
17		-	The flow is explicit: build and push an image, declare the app in a standalone TOML file, apply it, then deploy. Push transfers OCI content only — it never deploys.
	17	+	The flow is explicit: you build an image locally, push it to your registry then declare the app in a standalone TOML file, apply it, deploy and it's live.
18	18
19	19		## Quick Start
20	20

@@ -25,16 +25,13 @@ curl -fsSL https://bnema.dev/gordon/install \| sh
25	25		# Start the server (restart your shell first if the installer updated PATH)
26	26		gordon serve
27	27		```
28		-
29		-	The installer uses `~/.local/bin` without `sudo` and can add the effective install directory to Fish, Bash, or Zsh PATH configuration. Set `GORDON_UPDATE_PATH=1` to update PATH without prompting or `GORDON_UPDATE_PATH=0` to leave configuration unchanged. Override the destination with an absolute path such as `GORDON_INSTALL_DIR="$HOME/bin"`, `GORDON_INSTALL_DIR="$HOME/.local/bin"`, or `GORDON_INSTALL_DIR=/usr/local/bin`.
30		-
31		-	To build the current `next` branch commit locally, use `GORDON_CHANNEL=next`. This is an unverified development source build, not a checksum-verified release, and requires a compatible Go toolchain. See the [installation guide](https://bnema.dev/gordon/docs/installation#choosing-an-install-channel).
	28	+	See the [installation guide](https://bnema.dev/gordon/docs/installation#choosing-an-install-channel) for more.
32	29
33	30		Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://bnema.dev/gordon/docs/getting-started) for full setup.
34	31
35	32		## Deploy with the CLI
36	33
37		-	Build locally, push to your Gordon server, declare the app, deploy:
	34	+	Example of the flow :
38	35
39	36		```bash
40	37		# Push the image (OCI transfer only, never deploys)


@@ -12,9 +12,9 @@ Self-hosted container deployment. Push an image, declare an app, deploy it.
12			12
13		## What is Gordon?	13		## What is Gordon?
14			14
15	-	Gordon is a private container registry, an app runtime, and a reverse proxy for your VPS.	15	+	Gordon is a private image container registry, an app runtime, and a reverse proxy for your VPS.
16			16
17	-	The flow is explicit: build and push an image, declare the app in a standalone TOML file, apply it, then deploy. Push transfers OCI content only — it never deploys.	17	+	The flow is explicit: you build an image locally, push it to your registry then declare the app in a standalone TOML file, apply it, deploy and it's live.
18			18
19		## Quick Start	19		## Quick Start
20			20

@@ -25,16 +25,13 @@ curl -fsSL https://bnema.dev/gordon/install \| sh
25		# Start the server (restart your shell first if the installer updated PATH)	25		# Start the server (restart your shell first if the installer updated PATH)
26		gordon serve	26		gordon serve
27		```	27		```
28	-		28	+	See the [installation guide](https://bnema.dev/gordon/docs/installation#choosing-an-install-channel) for more.
29	-	The installer uses `~/.local/bin` without `sudo` and can add the effective install directory to Fish, Bash, or Zsh PATH configuration. Set `GORDON_UPDATE_PATH=1` to update PATH without prompting or `GORDON_UPDATE_PATH=0` to leave configuration unchanged. Override the destination with an absolute path such as `GORDON_INSTALL_DIR="$HOME/bin"`, `GORDON_INSTALL_DIR="$HOME/.local/bin"`, or `GORDON_INSTALL_DIR=/usr/local/bin`.
30	-
31	-	To build the current `next` branch commit locally, use `GORDON_CHANNEL=next`. This is an unverified development source build, not a checksum-verified release, and requires a compatible Go toolchain. See the [installation guide](https://bnema.dev/gordon/docs/installation#choosing-an-install-channel).
32			29
33		Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://bnema.dev/gordon/docs/getting-started) for full setup.	30		Config is created at `~/.config/gordon/gordon.toml`. See the [Getting Started guide](https://bnema.dev/gordon/docs/getting-started) for full setup.
34			31
35		## Deploy with the CLI	32		## Deploy with the CLI
36			33
37	-	Build locally, push to your Gordon server, declare the app, deploy:	34	+	Example of the flow :
38			35
39		```bash	36		```bash
40		# Push the image (OCI transfer only, never deploys)	37		# Push the image (OCI transfer only, never deploys)