Readme

Writes or improves a README (README.md) from codebase analysis, with run commands checked against build files, project screenshots and anti-AI writing rules. The prose avoids the patterns that make a README read as AI-generated. Use when asked to write, generate, create, update or rewrite a project README ("write a readme", "generate a README.md", "update my readme"), to critique, review, audit or improve an existing one ("/readme critique", "review my readme", "improve my readme"), or on "/readme". Supports minimal/standard/detailed verbosity and 20 project types. Screenshots are found in the

5 starsWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)

npx skills add ephemerallyCaden/write-readme --skill readme

Manual install

git clone --depth 1 https://github.com/ephemerallyCaden/write-readme.git /tmp/write-readme
mkdir -p ~/.claude/skills
cp -r /tmp/write-readme/. ~/.claude/skills/readme

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# write-readme

write-readme writes a project's README.md from its codebase. It detects the project type (one of 20), asks at most three questions, puts install and run commands checked against the build files first, uses real screenshots (found in the repo, or captured with Playwright or VHS), and holds the prose to anti-AI writing rules. Run it with `/readme`; `/readme critique` audits an existing README, and `/readme architecture` writes an ARCHITECTURE.md.

Generate a README.md by analyzing the current codebase, asking 0-3 questions, and producing a project-type-aware document that reads like a human wrote it.

`<skill-dir>` in the commands below is this skill's base directory; `references/`, `scripts/`, and `skills/` paths are relative to it.

`<draft-dir>` is this run's own draft directory, so two runs at once never overwrite each other's files. Create it once, at the start of Phase 3 (Enhance Mode too), with `mktemp -d /tmp/write-readme-draft.XXXXXX`. Note the path it prints and write that literal path wherever `<draft-dir>` appears, through Phase 6 and every Phase 5 revision; shell variables don't carry over from one command to the next. Never run that `mktemp` again in the same run. The directory mirrors project paths: `<draft-dir>/assets/screenshots/hero.png` is copied to `assets/screenshots/hero.png` in Phase 6.

Read the full skill on GitHub

Details

Skill name: readme
Repository: ephemerallyCaden/write-readme
License: MIT
Repo updated: 29 October 2026

FAQ

What does the Readme skill do?

How do I install the Readme skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add ephemerallyCaden/write-readme --skill readme. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Readme popular?

It lives in ephemerallyCaden/write-readme, which has 5 GitHub stars and 0 forks.

Related skills

Readme Generate

agenvoy/skill-readme-generate

從原始碼分析自動生成雙語 README。當使用者請求為專案建立 README、需要從程式碼庫生成 README.md（英文）和 README.zh.md（中文）、或希望為其函式庫/套件建立一致的多語言文件時使用。

Writing & Content

Rankcontrol

rankcontrol/rankcontrol

Operate the user's RankControl workspace (rctrl.com) from the command line - AI search visibility and citations (ChatGPT, Perplexity, Claude, Gemini, Grok, Google AI Mode, Google AI Overviews), SEO content planning, article generation and publishing to their CMS, backlinks and outreach, social repurposing, brand memory, and reports. Use this whenever the user asks about AI visibility, AI citations, GEO/AEO, being cited by ChatGPT, their content calendar, publishing articles, AI traffic attribution, or anything in their RankControl account, even if they don't name RankControl explicitly.

Writing & Content

Six Wise Minds

nightboy87/Six-Wise-Minds-Skill

Use this skill when the user needs help clarifying, stress-testing, comparing, or deciding a fuzzy issue through structured multi-perspective deliberation. Use for product decisions, writing topics, project choices, demand review, personal choices, career reflections, and other decisions where facts, emotions, risks, value, alternatives, and process all matter. Do not use for simple factual lookup, pure translation, pure rewriting, direct code execution, or as final medical/legal/financial/psychological advice.

Writing & Content

Project Showcase

ayushxx7/project-showcase-skill

Automate the creation of high-quality project showcases: UI captures, security scans, repo health audits, README injection, GitHub releases, and social media launches.

Writing & Content

Social Media Scraper

elbis330/social-media-scraper-skill

Skill that pulls and analyzes all data from social media posts. Fetches content from Instagram (reel, post, story), TikTok, Twitter/X and YouTube links. Collects all metadata including text, description, comments, like/share counts, date info, hashtags. Automatically transcribes with faster-whisper and applies visual analysis with Gemini Vision on posts containing video or audio. MANDATORY TRIGGERS: whenever a social media link is shared (instagram.com, tiktok.com, x.com, twitter.com, youtube.com, youtu.be), "read this tweet", "fetch this reel", "analyze this video", "look at this post", "what

Writing & Content

Novel Writing Coach

chanceline-max/novelist-skill

指导模型原创小说的选题、策划、大纲、人物、剧情、章节、续写、改稿、卡文与长篇连续性管理；适用于男频、女频、言情、玄幻、都市、悬疑、现实、无限流等题材。

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.