Skill

generate-readme

Generate or refresh a userscript repo's README.md from its `==UserScript==` metadata block — install button, what it does, supported sites, version, license. Idempotent; safe to re-run after metadata changes.

npx claudepluginhub danielrosehill/claude-code-plugins --plugin userscript-development

Tool Access

This skill uses the workspace's default tool permissions.

Preview

Build a clean README for a userscript repo by parsing its metadata block.

SKILL.md

Similar Skills

using-superpowers

180.9k

Mandates invoking relevant skills via tools before any response in coding sessions. Covers access, priorities, and adaptations for Claude Code, Copilot CLI, Gemini CLI.

3 files

superpowers

Stats

Stars0

Forks0

Last CommitMay 2, 2026

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

Generate README

Build a clean README for a userscript repo by parsing its metadata block.

Steps

Locate the .user.js file. If multiple exist, ask which one is canonical (or generate a multi-script README).

Parse the metadata block — extract: @name, @description, @version, @author, @match (all of them), @grant, @license, @homepageURL, @supportURL, @downloadURL.

Derive the install URL from @downloadURL if present, else compute it from the git remote.

Render this template (replace placeholders, drop sections with no data):

# <@name> <@description> ## Install [**Click here to install in Tampermonkey**](<install-url>) > Requires the [Tampermonkey](https://www.tampermonkey.net/) browser extension. ## What it does <one or two paragraphs — ask the user to expand if @description is too terse> ## Supported sites - `<@match #1>` - `<@match #2>` ## Permissions This script requests: `<@grant list, or "none">`. ## Version Current version: **<@version>**. See [commit history](<repo-url>/commits/main) for changes. ## Author <@author> — <@homepageURL or git remote owner URL> ## License <@license> ## Issues / feedback <@supportURL or repo Issues URL>

Write to README.md (overwrite). Show the user the diff vs. previous version.

Notes

Don't invent features that aren't in the script. Read the body for clues, but if behavior is non-obvious ask the user.

Keep it short — a userscript README that's longer than the script itself is a smell.

Generate README

Build a clean README for a userscript repo by parsing its metadata block.

Steps

Locate the .user.js file. If multiple exist, ask which one is canonical (or generate a multi-script README).
Parse the metadata block — extract: @name, @description, @version, @author, @match (all of them), @grant, @license, @homepageURL, @supportURL, @downloadURL.
Derive the install URL from @downloadURL if present, else compute it from the git remote.
Render this template (replace placeholders, drop sections with no data):

# <@name>

<@description>

## Install

[**Click here to install in Tampermonkey**](<install-url>)

> Requires the [Tampermonkey](https://www.tampermonkey.net/) browser extension.

## What it does

<one or two paragraphs — ask the user to expand if @description is too terse>

## Supported sites

- `<@match #1>`
- `<@match #2>`

## Permissions

This script requests: `<@grant list, or "none">`.

## Version

Current version: **<@version>**. See [commit history](<repo-url>/commits/main) for changes.

## Author

<@author> — <@homepageURL or git remote owner URL>

## License

<@license>

## Issues / feedback

<@supportURL or repo Issues URL>

Write to README.md (overwrite). Show the user the diff vs. previous version.

Notes

Don't invent features that aren't in the script. Read the body for clues, but if behavior is non-obvious ask the user.
Keep it short — a userscript README that's longer than the script itself is a smell.