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. | |||
| 28 | 28 | - Zero downtime updates, persistent volumes, environment merging | |
| 29 | 29 | - Single binary, ~15MB RAM | |
| 30 | 30 | ||
| 31 | - | ## Quick Start (5 minutes) | |
| 31 | + | ## Quick Start | |
| 32 | 32 | ||
| 33 | 33 | ### Prerequisites | |
| 34 | 34 | - Ubuntu/Debian VPS with root access | |
| @@ -126,12 +126,10 @@ backend = "pass" # "pass", "sops", or "unsafe" (plain text in data_dir) | |||
| 126 | 126 | # Registry authentication (choose password or token type) | |
| 127 | 127 | [registry_auth] | |
| 128 | 128 | enabled = true | |
| 129 | - | type = "password" # "password" or "token" | |
| 130 | - | ||
| 129 | + | type = "password" # "password" or "token" | |
| 131 | 130 | # Password auth: bcrypt hash stored in secrets backend | |
| 132 | 131 | username = "deploy" | |
| 133 | 132 | password_hash = "gordon/registry/password_hash" # path in secrets backend | |
| 134 | - | ||
| 135 | 133 | # Token auth: JWT-based authentication | |
| 136 | 134 | # token_secret = "gordon/registry/token_secret" # path in secrets backend | |
| 137 | 135 | ||
| @@ -328,16 +326,6 @@ Gordon is open source and welcomes contributions: | |||
| 328 | 326 | - [Suggest features](https://github.com/bnema/gordon/discussions) | |
| 329 | 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 | 329 | ## License | |
| 338 | 330 | ||
| 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 merging | 28 | - Zero downtime updates, persistent volumes, environment merging | ||
| 29 | - Single binary, ~15MB RAM | 29 | - Single binary, ~15MB RAM | ||
| 30 | 30 | ||||
| 31 | - | ## Quick Start (5 minutes) | 31 | + | ## Quick Start |
| 32 | 32 | ||||
| 33 | ### Prerequisites | 33 | ### Prerequisites | ||
| 34 | - Ubuntu/Debian VPS with root access | 34 | - 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 = true | 128 | enabled = true | ||
| 129 | - | type = "password" # "password" or "token" | 129 | + | type = "password" # "password" or "token" |
| 130 | - | ||||
| 131 | # Password auth: bcrypt hash stored in secrets backend | 130 | # Password auth: bcrypt hash stored in secrets backend | ||
| 132 | username = "deploy" | 131 | username = "deploy" | ||
| 133 | password_hash = "gordon/registry/password_hash" # path in secrets backend | 132 | password_hash = "gordon/registry/password_hash" # path in secrets backend | ||
| 134 | - | ||||
| 135 | # Token auth: JWT-based authentication | 133 | # Token auth: JWT-based authentication | ||
| 136 | # token_secret = "gordon/registry/token_secret" # path in secrets backend | 134 | # 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 | ## License | 329 | ## 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.⏎̸ | |||