---
license: mit
tags:
- github-readme
- open-source
- documentation
- copywriting
- developer-tools
- readme-template
- star-growth
- claude-code
- ai-agent
- technical-writing
- open-source-marketing
- tagline
- first-screen
- affine
- gingiris
language:
- en
- zh
- ja
- ko
task_categories:
- text-generation
- summarization
---

# GitHub README Writing System — 3-Second Conversion Framework

> Craft a README that converts visitors to stars in <3 seconds. Built from AFFiNE's 0→60K star journey.

## Install

```bash
npx skills add Gingiris-1031/gr-readme
```

Works with Claude Code, Cursor, Windsurf, and any AI agent that supports the [skills](https://skills.sh) protocol.

## What It Does

This skill guides you through writing a README that converts visitors into stars within the first 3 seconds of landing. It covers:

- **Tagline engineering** — write a one-line description that sticks
- **First-screen law** — what must appear above the fold
- **Section-by-section copywriting** — Features, Quick Start, Architecture, Contributing
- **Star CTA GIF** — placement and timing (front 3 screens, inline with hero or after Quick Start)
- **Claude Code AI Agent Integration** — dedicated section for AI-native projects
- **Anti-patterns** — 8 common README mistakes that kill conversions
- **30-item pre-publish checklist** — covers content, visuals, links, SEO, AI-era signals

## Based On

Real-world experience as ex-COO of [AFFiNE](https://github.com/toeverything/AFFiNE) (0→60K GitHub stars, $10M Pre-A). The patterns in this skill are what actually worked.

## Links

- 🌐 [gingiris.tools/skills/](https://gingiris.tools/skills/) — Browse all Gingiris skills
- 📦 [GitHub standalone repo](https://github.com/Gingiris-1031/gr-readme)
- 🔧 [skills.sh](https://skills.sh/Gingiris-1031/gr-readme)
- 📚 [All skills monorepo](https://github.com/Gingiris-1031/gingiris-skills)

## License

MIT-0 — free to use, modify, and distribute.