Skip to content

Improve header for better first impression#136

Merged
em3s merged 10 commits intomainfrom
docs/readme
Jan 27, 2026
Merged

Improve header for better first impression#136
em3s merged 10 commits intomainfrom
docs/readme

Conversation

@eazyhozy
Copy link
Copy Markdown
Member

@eazyhozy eazyhozy commented Jan 27, 2026

Summary

Improve README header for better first impression.

Changes

  • Add tl;dr with tagline, production metrics, and tech stack
  • Consolidate badges into single line
  • Split intro into two paragraphs (problem → solution)
  • Add quick links: Documentation, Open-sourced, Why I built this, Production stories
  • Remove duplicate "Why We Built This" from Learn More section

How to Test

Review the rendered README on GitHub.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@eazyhozy eazyhozy requested a review from em3s as a code owner January 27, 2026 11:25
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jan 27, 2026
@eazyhozy eazyhozy requested a review from zipdoki January 27, 2026 11:25
- Add value proposition at top (pre-computed reads, 1M+ req/min)
- Consolidate Open-sourced, Why I built this, Production stories into single line
- Remove duplicate "Why We Built This" from Learn More section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jan 27, 2026
@eazyhozy eazyhozy self-assigned this Jan 27, 2026
- Move badges below tl;dr, inline on single line
- Consolidate intro into one sentence with value proposition
- Move documentation/story links to bottom as CTA

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Jan 27, 2026
em3s and others added 5 commits January 27, 2026 21:06
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@em3s em3s changed the title docs: revamp README for Show HN landing docs(readme): improve header for better first impression Jan 27, 2026
em3s and others added 2 commits January 27, 2026 21:29
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@em3s em3s merged commit 1849730 into main Jan 27, 2026
9 checks passed
@em3s em3s removed request for em3s and zipdoki January 27, 2026 12:35
@em3s
Copy link
Copy Markdown
Contributor

em3s commented Jan 27, 2026

LGTM 👍

@em3s em3s changed the title docs(readme): improve header for better first impression Improve header for better first impression Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants