chore(docs): Simplify README by referencing installation guide
Removed detailed installer instructions and added a reference to the installation guide.
- commit
- 3cf12ba71b61f1d7e452edb326dc5a0b84fa52dd
- author
- bnema · · 2026-10-03 14:00 UTC
- committer
- GitHub · · 2026-10-03 14:00 UTC
- parent
- cf652cb
- signature
- GPG Unverified
B5690EEEBB952194The key is unknown
1 file · +2 -5
M README.md +2 -5
| @@ -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) | |
| @@ -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) | ||