From 158ead08f35b0f637328ca608cff0a125d6ba946 Mon Sep 17 00:00:00 2001 From: mkelvers Date: Mon, 20 Apr 2026 01:16:03 +0200 Subject: [PATCH] docs: reword cmd README to match main README prose --- cmd/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/cmd/README.md b/cmd/README.md index 7e5788a..01ec5ca 100644 --- a/cmd/README.md +++ b/cmd/README.md @@ -1,11 +1,9 @@ -# cmd layout +# cmd -This repository keeps executable entrypoints under `cmd/`. +Executable entrypoints live here. - `cmd/server`: main web process (`go run ./cmd/server`) -Why this exists: +## Why this structure -- Keeps the repository root focused on project metadata (`README.md`, `go.mod`, `Dockerfile`, etc) -- Scales cleanly if more binaries are added later (for example: `cmd/migrate`, `cmd/admin`, `cmd/worker`) -- Matches common Go repository conventions for multi-binary or growing services +I wanted to keep the repository root clean and focused on project metadata like `README.md`, `go.mod`, and `Dockerfile`. Keeping entrypoints under `cmd/` also makes it easy to add more binaries later without cluttering the root, and it matches standard Go conventions for projects that grow beyond a single binary. \ No newline at end of file