docs: fix Run-your-project command to match the shipped scaffold

[devantler]

🤖 Generated by the Daily AI Assistant

Problem

The README Usage → Run your project step documents a command that fails on the as-shipped template:

go run ./<project>

There is no <project> directory in the scaffold — cmd/, internal/, and pkg/ ship as empty .gitkeep placeholders, and the runnable entry point is the root main.go (package main). So the documented command errors for any user, with or without substituting a name:

$ go run ./<project>
stat .../<project>: directory not found      # exit 1
$ go run ./project
stat .../project: directory not found        # exit 1

Fix

Document the command that actually runs the shipped scaffold out of the box:

go run .          # runs the root main.go → exit 0

This is consistent with the whole-module forms already documented in the same Usage section (go build ./..., go test ./...) and with the "works from a clean baseline" spirit of the template. A user who later moves their entry point under cmd/<name>/ will naturally adjust to go run ./cmd/<name>.

Validation

Verified against a fresh clone on go1.26.4:

command	result
go run .	exit 0 ✅
go run ./<project> (as written)	exit 1 — directory not found
go run ./project (placeholder substituted)	exit 1 — directory not found

Docs-only, single-line change; AGENTS.md and the rest of the README were reviewed and are accurate (no further drift).

[github-actions]

✅MegaLinter analysis: Success

Descriptor	Linter	Files	Fixed	Errors	Warnings	Elapsed time
✅ ACTION	actionlint	6		0	0	0.36s
✅ ACTION	zizmor	6	0	0	0	1.31s
✅ BASH	bash-exec	1		0	0	0.01s
✅ BASH	shellcheck	1		0	0	0.02s
✅ BASH	shfmt	1	0	0	0	0.01s
✅ COPYPASTE	jscpd	yes		no	no	0.97s
✅ EDITORCONFIG	editorconfig-checker	29		0	0	0.04s
✅ GO	golangci-lint	yes	yes	no	no	19.84s
✅ JSON	jsonlint	1		0	0	0.46s
✅ JSON	prettier	1	0	0	0	0.63s
✅ JSON	v8r	1		0	0	2.4s
✅ MARKDOWN	markdownlint	5	0	0	0	1.11s
✅ MARKDOWN	markdown-table-formatter	5	0	0	0	0.26s
✅ REPOSITORY	checkov	yes		no	no	24.61s
✅ REPOSITORY	gitleaks	yes		no	no	0.11s
✅ REPOSITORY	git_diff	yes		no	no	0.01s
✅ REPOSITORY	grype	yes		no	no	57.32s
✅ REPOSITORY	osv-scanner	yes		no	no	2.74s
✅ REPOSITORY	secretlint	yes		no	no	1.02s
✅ REPOSITORY	syft	yes		no	no	2.0s
✅ REPOSITORY	trivy	yes		no	no	10.74s
✅ REPOSITORY	trivy-sbom	yes		no	no	0.19s
✅ REPOSITORY	trufflehog	yes		no	no	3.42s
✅ SPELL	lychee	16		0	0	0.59s
✅ YAML	prettier	10	0	0	0	0.63s
✅ YAML	v8r	10		0	0	11.91s
✅ YAML	yamllint	10		0	0	0.67s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Show us your support by starring ⭐ the repository