detached 9a2dd31

docs: clean up README formatting

- Remove time estimate from Quick Start header
- Remove redundant Why Gordon section and closing tagline
- Fix excessive whitespace in config example
commit
9a2dd3126a71fda259cf9e640672b93bcb6a7cca
author
brice · · 2026-01-12 21:29 UTC
committer
brice · · 2026-01-12 20:30 UTC
parent
b5a29f1
signature
unsigned
1 file · +3 -15
M README.md +3 -15
@@ -28,7 +28,7 @@ Build on your machine, push to deploy. Works from your laptop or CI.
2828 - Zero downtime updates, persistent volumes, environment merging
2929 - Single binary, ~15MB RAM
3030
31-## Quick Start (5 minutes)
31+## Quick Start
3232
3333 ### Prerequisites
3434 - Ubuntu/Debian VPS with root access
@@ -126,12 +126,10 @@ backend = "pass" # "pass", "sops", or "unsafe" (plain text in data_dir)
126126 # Registry authentication (choose password or token type)
127127 [registry_auth]
128128 enabled = true
129-type = "password" # "password" or "token"
130-
129+type = "password" # "password" or "token"
131130 # Password auth: bcrypt hash stored in secrets backend
132131 username = "deploy"
133132 password_hash = "gordon/registry/password_hash" # path in secrets backend
134-
135133 # Token auth: JWT-based authentication
136134 # token_secret = "gordon/registry/token_secret" # path in secrets backend
137135
@@ -328,16 +326,6 @@ Gordon is open source and welcomes contributions:
328326 - [Suggest features](https://github.com/bnema/gordon/discussions)
329327 - [Submit PRs](https://github.com/bnema/gordon/pulls)
330328
331-## Why Gordon?
332-
333-Most deployment tools require a CI/CD pipeline before you can ship anything. Gordon works the other way: push from your laptop on day one, add GitHub Actions when the project grows.
334-
335-Your dev machine has 16 cores and 32GB RAM. Your VPS has 2 cores and 2GB. Why rebuild everything on the weak machine? Build locally, push the result.
336-
337329 ## License
338330
339-GPL-3.0 - Use freely, contribute back.
340-
341----
342-
343-If your deployment process has more YAML than application code, something went wrong.⏎̸
331+GPL-3.0 - Use freely, contribute back.⏎̸
@@ -28,7 +28,7 @@ Build on your machine, push to deploy. Works from your laptop or CI.
28 - Zero downtime updates, persistent volumes, environment merging28 - Zero downtime updates, persistent volumes, environment merging
29 - Single binary, ~15MB RAM29 - Single binary, ~15MB RAM
30 30
31-## Quick Start (5 minutes)31+## Quick Start
32 32
33 ### Prerequisites33 ### Prerequisites
34 - Ubuntu/Debian VPS with root access34 - Ubuntu/Debian VPS with root access
@@ -126,12 +126,10 @@ backend = "pass" # "pass", "sops", or "unsafe" (plain text in data_dir)
126 # Registry authentication (choose password or token type)126 # Registry authentication (choose password or token type)
127 [registry_auth]127 [registry_auth]
128 enabled = true128 enabled = true
129-type = "password" # "password" or "token"129+type = "password" # "password" or "token"
130-
131 # Password auth: bcrypt hash stored in secrets backend130 # Password auth: bcrypt hash stored in secrets backend
132 username = "deploy"131 username = "deploy"
133 password_hash = "gordon/registry/password_hash" # path in secrets backend132 password_hash = "gordon/registry/password_hash" # path in secrets backend
134-
135 # Token auth: JWT-based authentication133 # Token auth: JWT-based authentication
136 # token_secret = "gordon/registry/token_secret" # path in secrets backend134 # token_secret = "gordon/registry/token_secret" # path in secrets backend
137 135
@@ -328,16 +326,6 @@ Gordon is open source and welcomes contributions:
328 - [Suggest features](https://github.com/bnema/gordon/discussions)326 - [Suggest features](https://github.com/bnema/gordon/discussions)
329 - [Submit PRs](https://github.com/bnema/gordon/pulls)327 - [Submit PRs](https://github.com/bnema/gordon/pulls)
330 328
331-## Why Gordon?
332-
333-Most deployment tools require a CI/CD pipeline before you can ship anything. Gordon works the other way: push from your laptop on day one, add GitHub Actions when the project grows.
334-
335-Your dev machine has 16 cores and 32GB RAM. Your VPS has 2 cores and 2GB. Why rebuild everything on the weak machine? Build locally, push the result.
336-
337 ## License329 ## License
338 330
339-GPL-3.0 - Use freely, contribute back.331+GPL-3.0 - Use freely, contribute back.⏎̸
340-
341----
342-
343-If your deployment process has more YAML than application code, something went wrong.⏎̸

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 7

Tags 106

↑↓ moveenter openesc close