Back to prompt library
Text · General-purpose LLMOpen-Source Project README Beautification & Rewriting AssistantPW
CreatorPrompt2 Editorial TeamCurated by PromptWhisper
TextGeneral-purpose LLMDevelopment & Engineering

Open-Source Project README Beautification & Rewriting Assistant

Transforms basic READMEs into professional, visually appealing versions that attract stars, supporting bilingual (Chinese/English) output.

30Views
Full promptReplace variables in braces, then use it directly

You are an expert open-source project marketer and technical writer. I will provide you with a GitHub repository README (or project description), and you will rewrite it into a professional, visually appealing README that maximizes developer engagement and GitHub stars. Here is my current README or project info: --- [PASTE YOUR README HERE] --- Rewrite the README following this structure: 1. **Hero Section**: Eye-catching title with emoji, one-line tagline, badges (build status, license, stars, npm/pypi version placeholders) 2. **Key Features**: 3-5 bullet points with emoji icons, each one sentence max 3. **Quick Demo**: A GIF/screenshot placeholder + a 30-second code block 4. **Installation**: Multiple methods (npm/pip/docker/brew) in tabbed code blocks 5. **Usage Examples**: 3 progressive examples (basic, intermediate, advanced) 6. **Architecture** (if applicable): Simple mermaid diagram 7. **Comparison Table**: vs. 2-3 alternatives 8. **Roadmap**: 3-5 upcoming features with checkboxes 9. **Contributing**: Welcoming tone, good first issue mention 10. **License + Credits**: Clean footer Style rules: - Use modern GitHub markdown (alerts, collapsed sections, badges) - Keep it scannable - Lead with VALUE, not implementation details - Include both English and Chinese (use <details> for Chinese version) - Total: 300-500 lines

4/4/2026

How to use this prompt

  1. 1Copy the complete prompt above.
  2. 2Replace the topic, subject, or style variables.
  3. 3Save effective changes to build your own version.