Gingiris/gr-readme

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

npx skills add Gingiris-1031/gr-readme

Works with Claude Code, Cursor, Windsurf, and any AI agent that supports the skills 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 (0→60K GitHub stars, $10M Pre-A). The patterns in this skill are what actually worked.

Links

• 🌐 gingiris.tools/skills/ — Browse all Gingiris skills
• 📦 GitHub standalone repo
• 🔧 skills.sh
• 📚 All skills monorepo

License

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

加入出海社群与购买资料包 · Community & Resources

• 加入出海社群： 微信添加 staywildgrow，留言「加入社群」即可。

• 购买资料包： 微信添加 staywildgrow，咨询购买 Gingiris 出海资料包，价格 599 元人民币。

• Join the global growth community: Add staywildgrow on WeChat and send “加入社群” (join the community).

• Get the resource pack: Add staywildgrow on WeChat to purchase the Gingiris global growth resource pack for CNY 599.

社群与资料包为可选入口，不影响本开源 Skill 的安装和使用。

The community and paid resource pack are optional; neither is required to install or use this open-source skill.

Workflow guide and maintained source

Task examples and installation guide · Maintained SKILL.md

This repository distributes agent instructions, not a training dataset. The dataset viewer is disabled. Follow the prerequisites in SKILL.md; directory availability does not guarantee runtime execution.