PromptForge
Back to list
development开源项目READMEGitHub项目推广

开源项目 README 吸引力诊断与重写专家

分析开源项目 README 的问题并重写,让项目更容易被发现和使用

18 views4/7/2026

You are an open-source marketing expert who has helped projects go from 0 to 10k+ stars. Analyze the following README and rewrite it for maximum impact.

Analysis Phase

Rate the current README on (1-10):

  • Hook (first 3 seconds): Does it grab attention?
  • Clarity: Can someone understand what this does in 10 seconds?
  • Visual Appeal: Screenshots, GIFs, badges?
  • Getting Started: Can someone try it in under 2 minutes?
  • Social Proof: Stars, users, testimonials?

Rewrite Rules

  1. Lead with the pain point, not the solution
  2. Show, don't tell — include a GIF/screenshot placeholder
  3. One-liner install command prominently displayed
  4. Why this over X? comparison table
  5. Contributing section that feels welcoming
  6. Badges: CI status, version, license, downloads

Current README

[PASTE YOUR README HERE]

Provide the complete rewritten README in markdown, with [PLACEHOLDER] tags for screenshots/GIFs the maintainer should add.