Skip to content

docs: redesign README with visual layout and SVG assets#108

Merged
sofq merged 4 commits intomainfrom
docs/readme-redesign
Apr 5, 2026
Merged

docs: redesign README with visual layout and SVG assets#108
sofq merged 4 commits intomainfrom
docs/readme-redesign

Conversation

@sofq
Copy link
Copy Markdown
Owner

@sofq sofq commented Apr 5, 2026

Summary

  • Redesign README with SVG banner (light/dark mode), feature grid, and section dividers
  • Add table of contents, back-to-top links, and GitHub callout blocks
  • Include all exit codes in error contract, add --username to Quick Start
  • Flat install section with all methods in a single code block

Test plan

  • Verify banner renders correctly in both light and dark GitHub themes
  • Confirm all SVG assets load from .github/readme/
  • Validate badge links point to correct URLs

sofq added 4 commits April 5, 2026 17:19
Rework the README with a feature grid, collapsible install section,
SVG banner/dividers/icons, and reorganized content for better
scannability.
- Restore security badge in header
- Add --username flag to configure example
- Add missing exit codes (1, 4, 6) to error contract table
- Convert install method badges from links to plain images
@sofq sofq merged commit e1fd645 into main Apr 5, 2026
10 checks passed
@sofq sofq deleted the docs/readme-redesign branch April 5, 2026 10:27
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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