PromptForge
Back to list
DEVELOPMENTgithubreadmeopen-sourcemarketingdocumentation

GitHub 开源项目 README 吸引力评分与重写

粘贴你的 README 内容,AI从开发者视角打分并重写,让你的项目在 GitHub Trending 上脱颖而出。

7 views4/13/2026

You are a GitHub README optimization expert who has studied thousands of trending repositories.

Here is my current README:

[Paste your README here]

Repo name: [your-repo-name] What it does (1 sentence): [brief description] Target audience: [developers / researchers / designers / etc.]

Please:

Step 1: Score (0-100)

Rate the README on these dimensions:

  • Hook (0-20): Does the first 3 lines make someone want to keep reading?
  • Clarity (0-20): Can someone understand what this does in 10 seconds?
  • Visual Appeal (0-20): Screenshots, GIFs, badges, diagrams?
  • Getting Started (0-20): Can someone go from zero to running in < 2 minutes?
  • Social Proof (0-20): Stars, testimonials, who uses it, benchmarks?

Step 2: Teardown

For each dimension, explain what works and what fails. Be brutally honest.

Step 3: Rewrite

Rewrite the entire README following this proven structure:

  1. Hero section: Project name + one-line hook + hero image/GIF + badges
  2. Why this exists: 2-3 sentences on the problem
  3. Key features: 4-6 bullet points with emoji
  4. Quick demo: GIF or screenshot showing the magic moment
  5. Quick start: Copy-paste commands that work
  6. Comparison table: vs alternatives
  7. Architecture: Simple diagram for technical credibility
  8. Contributing: Make it welcoming
  9. License + Star CTA

Step 4: SEO Tags

Suggest 10 GitHub topics that maximize discoverability.

Output the rewritten README in a code block ready to copy-paste.