Skip to content

Redesign README with brand colors and visual polish#1

Merged
diranged merged 12 commits into
mainfrom
docs/redesign-readme
Apr 7, 2026
Merged

Redesign README with brand colors and visual polish#1
diranged merged 12 commits into
mainfrom
docs/redesign-readme

Conversation

@diranged

@diranged diranged commented Apr 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • Embed the Graftery icon SVG at the top for instant brand recognition
  • Apply the teal (#0e6878, #094858) and coral (#c94a30) color scheme from docs/icon.svg throughout via shields.io badges
  • Restructure content with collapsible <details> sections for troubleshooting and CLI flags to reduce visual noise
  • Improve scannability with requirement/config/hook tables and a provisioning flow diagram
  • All original content preserved — no information removed

Test plan

  • Verify README renders correctly on GitHub (SVG, badges, collapsible sections, tables)
  • Check shields.io badges load with correct colors
  • Confirm all internal links (#base-vm-image-requirements, examples/) resolve correctly

🤖 Generated with Claude Code

Matt Wise and others added 12 commits April 6, 2026 17:18
Incorporate the Graftery icon SVG, use teal/coral color scheme from the
icon throughout via shields.io badges, add collapsible sections for
troubleshooting and CLI flags, improve scannability with tables and
visual hierarchy.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
GitHub's markdown sanitizer doesn't reliably render SVGs in <img> tags.
Convert icon.svg to a PNG for the header image.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The table-with-empty-column approach rendered with awkward indentation.
Replace with GitHub's native [!NOTE] blockquote syntax.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Split into distinct sections: macOS App (DMG install, wizard, menu bar)
  and CLI (binary download, flags, config file)
- Make DMG the primary install path with prominent placement
- Remove unnecessary collapsible wrapper around config file location
- Add comparison table in overview so users pick their path immediately
- Image provisioning and troubleshooting remain shared sections
- Use colored for-the-badge headers to visually separate major sections

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Use the new asymmetric graft icon (icons/icon.svg) rendered as PNG
for GitHub compatibility. Removes reference to old docs/icon.png.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add LICENSE file (Apache License 2.0)
- Add copyright headers to all 54 source files (.go, .swift, .sh, .py)
- Update README badge and license section from TBD to Apache 2.0

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace minimal overview with a full selling section that explains:
- Why Graftery exists (the problem it solves)
- How it works (ASCII flow diagram)
- Core capabilities table (ephemeral VMs, auto-scaling, image baking,
  hooks, crash recovery, Prometheus metrics, dry-run mode)
- Detailed comparison of macOS App vs CLI (multi-config, metrics
  visualization, log viewer, setup wizard vs single-process simplicity)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The tiny shields.io badges in the table's first column were too small
to read. Switch to a simple bold-text list which is cleaner and more
scannable.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Include wizard (name + auth steps), menu bar dropdown, and config
editor screenshots. Redact org/personal names from config editor.
Rewrite Quick Start to be UI-focused with inline images instead of
referencing config file paths.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Use an HTML table with valign=top to guarantee vertical alignment.
Add captions below each image.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Regenerate DMG background with light-teal gradient and subtle helix
  motif so Finder's black icon labels are readable
- Add coral drag-arrow between app and Applications positions
- Stamp V2 app icon onto the .dmg file via DeRez/Rez
- Add --volicon for mounted volume icon
- Fix Package.swift: swift-tools-version must be on line 1

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@diranged diranged merged commit 6c3bee6 into main Apr 7, 2026
3 checks passed
@diranged diranged deleted the docs/redesign-readme branch April 7, 2026 01:36
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