docs(readme): add --help flag to go run configuration examples
- Dominant language
- Go
- Stars
- 126
- Forks
- 87
- PR merge metrics
- No merged PRs in 30d
Description
The README says to run 'go run api/cmd/main.go' and 'go run archiver/cmd/main.go' to see configuration options, but running without --help starts the binary instead of printing the options. The correct commands are 'go run api/cmd/main.go --help' and 'go run archiver/cmd/main.go --help'. Verified both commands print the full configuration list with --help.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the README and find the configuration-option examples for the API and archiver commands. Update both commands to include --help, then run each command to confirm that it prints the full configuration list instead of starting the binary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 95/100