Is the Crafting Effective READMEs skill free?

Yes. The skill itself is free from softaworks/agent-toolkit. SkillProof publishes the install command and an independent test verdict at no cost.

What is the Crafting Effective READMEs SkillProof Score?

9.2/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 8/10, docs & honesty 5/5.

How do I install Crafting Effective READMEs?

Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.

Can I use Crafting Effective READMEs with Cursor, Copilot, Gemini CLI, Codex or other AI tools?

The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.

Crafting Effective READMEs

Interview-driven README generator with separate templates for OSS, personal, internal, and config repos.

by softaworks · softaworks/agent-toolkit

Tested · Works

Install — copy the command Download source ↗

Test report

Verdict: Tested · Works
Score: 9.2/10
Tested: Jul 13, 2026
Environment: Claude Code 2.x (agent harness)
Upstream re-checked: Aug 10, 2026 · a6c30d9

For a new OSS CLI tool it didn't just write prose — it asked the project-type question first, then filled the OSS template's Contributing/Roadmap/Dev-setup sections that a baseline, unguided draft skipped entirely.

Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works

Installs cleanly 5/5
Triggers reliably 5/5
Output vs. baseline 8/10
Docs & honesty 5/5

What Crafting Effective READMEs does

Asks a short set of audience/task questions (creating vs adding vs updating vs reviewing, and project type) before drafting a README, then applies one of four purpose-built templates instead of a generic outline. Triggers when writing, adding to, updating, or reviewing a README file.

How to install Crafting Effective READMEs

git clone https://github.com/softaworks/agent-toolkit
cd agent-toolkit
mkdir -p ~/.claude/skills
cp -r dist/plugins/crafting-effective-readmes/skills/crafting-effective-readmes ~/.claude/skills/crafting-effective-readmes

Skills live in ~/.claude/skills/ (global) or .claude/skills/ (per-project). Restart Claude Code after installing.

Commands — how to trigger Crafting Effective READMEs

/crafting-effective-readmes Interview-driven README generator with separate templates for OSS, personal, internal, and config repos.

It also activates on plain-language prompts like these:

Help me write a README for this open source project from scratch
I need to update our internal repo's README, ask me what it needs first
Review my project's README and tell me what's missing for new users

Frequently asked questions

Is the Crafting Effective READMEs skill free?: Yes. The skill itself is free from softaworks/agent-toolkit. SkillProof publishes the install command and an independent test verdict at no cost.
Does Crafting Effective READMEs work with Claude Code?: We tested it with Claude Code 2.x (agent harness) on Jul 13, 2026. Verdict: Tested · Works. For a new OSS CLI tool it didn't just write prose — it asked the project-type question first, then filled the OSS template's Contributing/Roadmap/Dev-setup sections that a baseline, unguided draft skipped entirely.
What is the Crafting Effective READMEs SkillProof Score?: 9.2/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 8/10, docs & honesty 5/5.
How do I install Crafting Effective READMEs?: Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
Can I use Crafting Effective READMEs with Cursor, Copilot, Gemini CLI, Codex or other AI tools?: The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.