Skip to content
Muse SkillsIndependent
Submit a skill

README Writer

Points at a repo, gets a real README draft: setup, usage, config.

Tested in Museprompt packDev & automationprompt-text

by Muse Skills editors · Written for this directory

View source

Ready to copy.

What it does

README Writer is a prompt pack for the repo with no README. Point it at the code and get a real draft: what and why, exact quickstart commands, every env var explained, usage examples, and dev setup. Every command comes from the repo itself; anything unverified gets marked.

What it includes

  • What-and-why intro paragraph
  • Verified quickstart commands
  • Full config and env var reference
  • Usage examples and dev setup

Example

Input: a small CLI tool repo with a package.json and .env.example.

Output (abridged):

# bill-tracker

Watches recurring charges and reports monthly totals.

## Quickstart
npm install
cp .env.example .env
npm start

## Configuration
| Var | What it does |
| DATABASE_URL | Postgres connection [unverified] |

What this one touches

Drafts documentation from the repo you point it at. Never commits or publishes anything.

Install

Copy this block and paste it into your Muse chat. Muse does the install and confirms when it's done.

Install prompt

Full source

This is the exact text Muse installs. Read it. That's the whole trust model.

SKILL.md
This prompt pack drafts a README from a repository.
Paste it into Muse along with the repo path or contents.

> Write a README for this repo. Structure: (1) one-paragraph
> what and why, (2) quickstart, the exact commands to go from
> clone to running, (3) configuration, every env var and
> config file with what it does, (4) usage, the main commands
> or API with one example each, (5) development, how to run
> tests and contribute. Rules: every command must come from
> the repo itself (package.json, Makefile, docs), never
> invent a command, (2) mark anything you couldn't verify with
> [unverified], (3) keep it scannable, headers, code blocks,
> no paragraphs over 4 lines. Do not commit; just draft it.
  • Release Notes Writer

    Turns commits and merged PRs since the last tag into a changelog draft worth shipping.

    skillinstructionsworkflowchangelog-templatemigration-notes

    by Muse Skills editors · Written for this directory

    View
  • Release Radar

    Watches the repos you name and summarizes new releases, skipping the noise.

    skillinstructionsworkflowrepo-watch-list

    by Muse Skills editors · Written for this directory

    View
  • Dependency Update Triage

    Turns a scary outdated-dependencies list into safe-now, review, and hold buckets.

    Tested in Museskillinstructionsworkflowreport

    by Muse Skills editors · Written for this directory

    View
  • Git Commit Writer

    Your diff in, conventional-commit message out.

    Tested in Museprompt packprompt-text

    by Muse Skills editors · Written for this directory

    View