Skip to content

Improve README structure and formatting#31

Merged
veerendra2 merged 2 commits into
mainfrom
feat/improve-readme
Jun 5, 2026
Merged

Improve README structure and formatting#31
veerendra2 merged 2 commits into
mainfrom
feat/improve-readme

Conversation

@veerendra2

Copy link
Copy Markdown
Owner

Summary

  • Add badges for CI, release, license, stars, forks, and container registry
  • Reorganize sections with proper heading hierarchy (Deployment, Development, etc.)
  • Move inspiration footer to bottom with horizontal rule separator
  • Update asset paths from dashboards/ to assets/
  • Improve section consistency and remove duplicate text

Changes

  • Added centered badges matching project style guide
  • Restructured headings: Quick StartUsage, added Deployment and Development sections
  • Fixed Docker Compose heading level
  • Cleaned up duplicate text in Taskfile, GoReleaser, and Dev Compose sections
  • Moved footer acknowledgment to bottom with separator

🤖 Generated with Claude Code

veerendra2 and others added 2 commits June 5, 2026 13:35
- Add badges for CI, release, license, stars, forks, and container registry
- Reorganize sections with proper heading hierarchy
- Move inspiration footer to bottom with separator
- Update asset paths from dashboards/ to assets/
- Improve section organization and consistency

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@veerendra2
veerendra2 marked this pull request as ready for review June 5, 2026 11:39
@veerendra2
veerendra2 merged commit 12273db into main Jun 5, 2026
1 check passed
@veerendra2
veerendra2 deleted the feat/improve-readme branch June 5, 2026 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant