readme¶
Update README badges and version references.
Usage¶
Description¶
The readme command updates version references and badges in your README file. It can update coverage badges, version shields, and other dynamic content.
Arguments¶
| Argument | Description | Default |
|---|---|---|
directory |
Directory to process | Current directory (.) |
Flags¶
| Flag | Description |
|---|---|
--version |
Version to update to |
--dry-run |
Preview changes without writing |
--verbose, -v |
Show detailed output |
Examples¶
# Update README with current version
atrelease readme
# Update to specific version
atrelease readme --version=v1.0.0
# Preview changes
atrelease readme --version=v1.0.0 --dry-run
What Gets Updated¶
Coverage Badge¶
If gocoverbadge is available, the coverage badge is regenerated:
Version References¶
Version strings in installation instructions:
Badge URLs¶
Version-specific badge URLs are updated to reflect the new version.
Exit Codes¶
| Code | Meaning |
|---|---|
| 0 | README updated successfully |
| 1 | Error updating README |