Skip to content

Comments

Overhaul README for better developer conversion#364

Open
Taure wants to merge 3 commits intomasterfrom
feat/readme-overhaul
Open

Overhaul README for better developer conversion#364
Taure wants to merge 3 commits intomasterfrom
feat/readme-overhaul

Conversation

@Taure
Copy link
Collaborator

@Taure Taure commented Feb 23, 2026

Summary

Complete rewrite of the README to make it compelling for developers discovering Nova:

  • Hero section with centered logo, tagline, and badge row (build status, hex version, docs, Slack)
  • "Why Nova?" section — clear positioning as the web framework for Erlang developers
  • Quick start — 3 commands from zero to running app
  • Code example — shows what a controller and routes look like
  • Feature table — scannable overview of all capabilities
  • Request pipeline diagram — visual understanding of the architecture
  • Ecosystem table — links to all companion packages (kura, nova_test, opentelemetry_nova, etc.)
  • Documentation links — The Nova Book (now live), HexDocs, Quick Start guide
  • Community links — Slack, Forum, Issue Tracker

Test plan

  • Verify all links resolve (hex.pm badges, GitHub Actions badge, Nova Book URL)
  • Check rendering on GitHub (centered elements, tables, code blocks)
  • Verify image loads at specified width

🤖 Generated with Claude Code

Taure and others added 3 commits February 23, 2026 07:15
Replace minimal README with a compelling, structured overview:
- Centered hero with badges (build, hex, docs, slack)
- "Why Nova?" positioning section
- Quick start in 3 commands
- Controller code example showing the API
- Feature table, request pipeline diagram
- Ecosystem packages table
- Links to The Nova Book, HexDocs, and community

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Taure Taure requested a review from burbas February 24, 2026 07:39
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