Agent skill

Write Readme

Write or rewrite package README files in the style used by the Remix repository.

MITAuto-check passedDevelopment

Install Write Readme

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-readme --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-readme .claude/skills/write-readme && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .claude/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-readme --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/write-readme .agents/skills/write-readme && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .agents/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-readme --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/write-readme .cursor/skills/write-readme && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .cursor/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/remix-run/remix.git --path .agents/skills/write-readme

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-readme --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/write-readme .gemini/skills/write-readme && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .gemini/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install remix-run/remix write-readme

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/write-readme .github/skills/write-readme && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .github/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add remix-run/remix --skill write-readme -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-readme --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/write-readme .opencode/skills/write-readme && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "write-readme" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme into .opencode/skills/write-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-readme", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: write-readme
GitHub stars: 33k
Token cost: ~779 tokens
SKILL.md length: 415 words
Files: 2
Skills in repo: 19
Repo updated: Oct 6, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

Write or rewrite package README files in the style used by the Remix repository.

Works in 5 steps: Read the package API and at least one or… → Document the package as it exists today,… → Start with a realistic production usage… → …
Drafting a new package README
SKILL.md covers Overview, Workflow, Structure and Rules, plus 1 more section
Calls npm

What it does

Write Readme is an agent skill from remix-run/remix. Write or rewrite package README files in the style used by the Remix repository. Use when drafting a new package README, revising an existing README, or reviewing README structure, examples, installation instructions, and section ordering for Remix packages.

Its SKILL.md is about 780 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).

It sits in Development, covering Technical documentation. It works with Remix. The repository describes itself as: The fully-stacked web framework. The licence is MIT.

When your agent uses it

Drafting a new package README
Revising an existing README
Reviewing README structure
Installation instructions

Example prompts

“/write-readme”

Requirements

Node.js

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

Read the package API and at least one or two sibling package READMEs before drafting.
Document the package as it exists today, not the package you wish existed.
Start with a realistic production usage example as soon as the installation section is done.
Cover each major feature with a concrete example.
Finish with internal ecosystem links, external related work, and license info.

What it can do on your machine

Read from SKILL.md and the folder at commit 27bd7a4. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
- npm
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Write Readme loads about 779 tokens when it runs. Until then it costs about 68 tokens; SKILL.md has 415 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~68
When it runs · the whole SKILL.md, loaded when a task matches: ~779

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from remix-run/remix at commit 27bd7a4, republished under its MIT licence (© remix-run). 415 words, ~779 tokens.

Download SKILL.mdSave it as .claude/skills/write-readme/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.

name: write-readme
description: Write or rewrite package README files in the style used by the Remix repository. Use when drafting a new package README, revising an existing README, or reviewing README structure, examples, installation instructions, and section ordering for Remix packages.

Write Readme

Overview

Draft README files as concise package documentation for real users, not as marketing copy or API dumps. Mirror the structure used across this repository, keep examples production-oriented, and avoid awkward manual line breaks in prose.

Workflow

Read the package API and at least one or two sibling package READMEs before drafting.
Document the package as it exists today, not the package you wish existed.
Start with a realistic production usage example as soon as the installation section is done.
Cover each major feature with a concrete example.
Finish with internal ecosystem links, external related work, and license info.

Structure

Use this section order unless there is a strong package-specific reason not to:

# short package-name (i.e. fetch-router instead of @remix-run/fetch-router)
Intro: one or two sentences explaining what the package does and why it exists
## Features: a flat bullet list of the main highlights
## Installation
## Usage: a production-like example that shows the package in context
One section per major feature, each with focused examples
## Related Packages
## Related Work
## License

Rules

Installation should always start with:

npm i remix

If the package requires a third-party dependency or peer, include it explicitly in the installation section after remix.
Usage examples should import from remix/..., not @remix-run/....
The first example should look like real application code, not the smallest possible snippet.
Feature sections should show how to use the package's major capabilities in practice, with one example per capability when useful.
Keep prose compact. Do not hard-wrap paragraphs at awkward places in the middle of a sentence just to force a line length.
Prefer flat bullets and short paragraphs over long explanatory blocks.
Related Packages should point to relevant Remix packages in the monorepo.
Use full GitHub URLs for cross-file or cross-package repo links so README content still works when copied into generated docs. Keep same-document anchors and README self-links relative.
Related Work should point to external libraries, specs, standards, or prior art that help readers place the package.
License should use the standard repo wording and link.

Show full SKILL.md (68 more words)Show less

Checklist

Does the intro explain the package in one or two sentences?
Does the features list surface the package's main value quickly?
Does the installation section use npm i remix?
Does the main usage example show a realistic production scenario?
Does each major feature have an example?
Does the README end with Related Packages, Related Work, and License?
Does the prose read naturally without awkward manual line breaks?

Files

SKILL.md and 1 other file in .agents/skills/write-readme of remix-run/remix.

SKILL.md
agents/openai.yaml

Open the folder on GitHubat commit 27bd7a4

Compare with similar skills

Write Readme next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Write Readme compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Write Readme this skillremix-run/remix	33k	—	~779	Automated safety check: Pass	MIT	yesterday
Diagram Designcathrynlavery/diagram-design	44k	1 repos	~7.5k	Automated safety check: Pass	MIT	yesterday
Simple Englishmoeru-ai/airi	50k	2 repos	~4.6k	Automated safety check: Pass	MIT	today
Get API Docs with chubandrewyng/context-hub	14k	2 repos	~775	Automated safety check: Pass	MIT	4 mo ago
Doc SyncJetBrains/ideavim	10k	2 repos	~2.6k	Automated safety check: Pass	MIT	today
Mailspring App ScreenshotsFoundry376/Mailspring	18k	—	~1.4k	Automated safety check: Pass	GPL-3.0	today

Similar skills

Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
44k GitHub starsUsed in 1 repo~7.5k tokens
DevelopmentAuto-check passed
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
50k GitHub starsUsed in 2 repos~4.6k tokens
DevelopmentAuto-check passed
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
14k GitHub starsUsed in 2 repos~775 tokens
DevelopmentAuto-check passed
Doc Sync
JetBrains/ideavim
Official
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
10k GitHub starsUsed in 2 repos~2.6k tokens
DevelopmentAuto-check passed
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
18k GitHub stars~1.4k tokensUpdated today
DevelopmentAuto-check passed
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
10k GitHub stars~2.4k tokensUpdated 5 days ago
DevelopmentAuto-check: notes

Questions about Write Readme

What does Write Readme do?

Write or rewrite package README files in the style used by the Remix repository. Write Readme is an agent skill from remix-run/remix. Write or rewrite package README files in the style used by the Remix repository.

When should I use Write Readme?

Write Readme fits situations like: drafting a new package README; revising an existing README; reviewing README structure; installation instructions.

How do I install Write Readme in Claude Code?

Run `npx skills add remix-run/remix --skill write-readme -a claude-code`. Or copy the skill folder (.agents/skills/write-readme in remix-run/remix) into .claude/skills/write-readme in your project. Claude Code loads it when a task matches its description.

How do I install Write Readme in Codex?

Run `npx skills add remix-run/remix --skill write-readme -a codex`. Or copy the skill folder (.agents/skills/write-readme in remix-run/remix) into .agents/skills/write-readme in your project. Codex loads it when a task matches its description.

Can I use Write Readme in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add remix-run/remix --skill write-readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-readme, .gemini/skills/write-readme, .github/skills/write-readme and .opencode/skills/write-readme in your project.

What does Write Readme need to run?

Going by SKILL.md and its folder, Write Readme needs the command-line tools its instructions call (npm). Our summary lists: Node.js.

Does Write Readme access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Write Readme safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Write Readme use?

Write Readme is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Write Readme use?

About 779 tokens (SKILL.md is roughly 3.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Write Readme?

Skills that share tags, products or a category with Write Readme: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Write Readme?

remix-run (a GitHub organization) maintains it in remix-run/remix, which has 33,396 GitHub stars. The repository holds 19 skills in this directory. The repository was last updated on October 6, 2026.

Source: remix-run/remix on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Write Readme

Install Write Readme

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Write Readme

Overview

Workflow

Structure

Rules

Checklist

Files

Compare with similar skills

Similar skills

Diagram Design

Simple English

Get API Docs with chub

Doc Sync

Mailspring App Screenshots

Draw.io Diagram Studio

More from remix-run/remix

Supersede PR

Add Package

Author UI Primitives

Fix Issue

Make Demo

Make PR

Questions about Write Readme

Install Write Readme

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Write Readme

Overview

Workflow

Structure

Rules

Checklist

Files

Compare with similar skills

Similar skills

More from remix-run/remix

Related

Questions about Write Readme