Skip to content

docs: overhaul README with hero, badges, vision, and community CTAs#21

Merged
markovejnovic merged 7 commits into
mainfrom
feat/readme-improvement
May 26, 2026
Merged

docs: overhaul README with hero, badges, vision, and community CTAs#21
markovejnovic merged 7 commits into
mainfrom
feat/readme-improvement

Conversation

@markovejnovic
Copy link
Copy Markdown
Contributor

Summary

  • Rewrites README from dry reference doc into a compelling landing page (modeled after starship/uv/bun/just)
  • Adds centered hero with badges (CI, crates.io, Discord, Slack, license), warning banner about alpha status, elevator pitch with inline demo, feature highlights, vision section, and community CTAs
  • Moves reference material (DSL surface, flags, cloud commands, plugin authoring) behind collapsible <details> sections
  • Primary install method is now curl -fsSL https://get.harmont.dev/install.sh | sh

Test plan

  • Badges render correctly on GitHub (CI, Discord widget enabled, Slack)
  • All links resolve (harmont.dev, discord, slack invite, crates.io, pypi, examples/)
  • [!WARNING] admonition renders with GitHub styling
  • <details> sections expand/collapse
  • Centered HTML renders on GitHub

@markovejnovic markovejnovic marked this pull request as ready for review May 26, 2026 01:02
@markovejnovic markovejnovic merged commit b72c933 into main May 26, 2026
23 checks passed
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