Plugin

claudikins-grfp

Name: claudikins-grfp
Author: elb-pr

Five rituals for README perfection: /deep-dive the codebase, /crystal-ball the roadmap, /brain-jam with Gemini, enter the /think-tank, then /pen-wielding to write.

Component Overview

/brain-jam, /crystal-ball +4

Commands

Agents

brain-jam, crystal-ball +4

Skills

Hooks

MCP Servers

LSP Servers

Output Styles

Install

npx claudepluginhub elb-pr/claudikins-marketplace --plugin claudikins-grfp

Component Details

Commands (6)

claudikins-github-readme-for-perfectionists:brain-jam

/brain-jam

Stage 4 - Collaborate with Gemini to find the perfect README angle

claudikins-github-readme-for-perfectionists:crystal-ball

/crystal-ball

Stage 2 - Envision what this project COULD become

claudikins-github-readme-for-perfectionists:deep-dive

/deep-dive

Stage 1 - Deep dive into the codebase to understand what it IS

claudikins-github-readme-for-perfectionists:grfp

/grfp

Begin README creation workflow or check current progress and missed areas

claudikins-github-readme-for-perfectionists:pen-wielding

/pen-wielding

Stage 5 - Write the complete README with all insights combined

claudikins-github-readme-for-perfectionists:think-tank

/think-tank

Stage 3 - Research how similar projects nail their READMEs

Skills (6)

brain-jam

/brain-jam

Use when determining project tone, voice, and marketing angle after deep-dive and crystal-ball phases. Conducts brainstorming session with Gemini.

crystal-ball

/crystal-ball

Use when analysing future opportunities after deep-dive phase. Identifies performance improvements, technical debt, security hardening, and feature gaps. Outputs roadmap candidates table.

deep-dive

/deep-dive

Use when starting the README pipeline to extract technical facts from codebase. Identifies project type, tech stack, dependencies, entry points, CI configuration. Outputs Reality Report.

grfp

/grfp

Use when creating or updating a README. It enforces the 5-step 'Anti-Slop' pipeline and triggers the correct sub-skill for the current phase.

pen-wielding

/pen-wielding

Use when writing the final README after all phases complete. Synthesises outputs from deep-dive, crystal-ball, brain-jam, and think-tank. Applies Anti-Slop style guide.

think-tank

/think-tank

Use when researching documentation patterns after brain-jam phase. Analyses exemplar READMEs from similar high-star repositories, scores against rubric, extracts patterns.

README

Github Readme for Perfectionists

ESLint for prose. A Claude Code plugin that treats "delve" as a syntax error.

AI-generated documentation has a smell. You know it when you read it: "This tool delves into the landscape of seamless integration..." - zero information, pure filler. I bet reading that you thought, but this sounds like AI, you're right actually, written before using the plugin.

Before:

~~This library provides a seamless way to delve into documentation generation, unleashing the full potential of your README workflow.~~

After:

This plugin generates README files. It bans 15 filler words, enforces sentence patterns that require specifics, and includes humanisation patterns to make AI text sound human.

Quick Start

Install via Claude Code Plugin:

# Add the Claudikins marketplace
/marketplace add aMilkStack/claudikins-marketplace

# Install the plugin
/plugin install claudikins-grfp

Then ask Claude to write a README. The plugin triggers and runs you through 5 phases.

How It Works

flowchart LR
    A["/deep-dive"] --> B["/crystal-ball"]
    B --> C["/brain-jam"]
    C --> D["/think-tank"]
    D --> E["/pen-wielding"]

    A -.- A1["Facts: Stack, structure, friction"]
    B -.- B1["Future: Roadmap, tech debt"]
    C -.- C1["Voice: Angle, tone"]
    D -.- D1["Research: Patterns, badges"]
    E -.- E1["Output: The README"]

Each phase produces artifacts. /deep-dive extracts codebase facts. /crystal-ball identifies what's missing. /brain-jam runs a Claude + Gemini debate to find the voice. /think-tank researches exemplar READMEs. /pen-wielding writes the final output with Anti-Slop rules enforced.

What pen-wielding enforces

The final phase applies four governance files:

style-guide.md - Banned words, sentence patterns, humanisation techniques, phrase templates
structural-templates.md - Section ordering by project type, results tables, Do/Don't patterns
visual-engineering.md - Mermaid diagrams, ASCII progress bars, visual density rules
anti-patterns.md - Writing anti-patterns, research anti-patterns, quality checklist

Sentence Patterns

Three patterns you must vary between:

The Hook (Pain → Solution)

Use in: Description, Intro

Before	After
"This library helps with JSON parsing issues."	"JSON logs are unreadable. Kinesis parses them instantly."

The Hammer (Fact + Metric)

Use in: Features, Performance

Before	After
"The system is designed to be incredibly fast."	"Builds finish in under 200ms."

The Trust Builder (Constraint + Fallback)

Use in: Usage, Technical sections

Before	After
"Works perfectly on all platforms."	"Uses `epoll` on Linux; falls back to `kqueue` on macOS."

Humanisation Patterns

Write TO readers, not AT them.

Weak	Strong	Why
"Users can optionally configure..."	"Configure your preferences in..."	Direct address over passive
"The system enables..."	"This helps you..."	Human over system
"Consider implementing..."	"Implement..."	Commands over suggestions
"We achieved 2.4M reach"	"We reached 2.4M people, 20% above target"	Context makes numbers meaningful

ASCII Visualisations

For lightweight progress and status without images.

Status Indicators

View full README on GitHub

Similar Plugins

vibeworks-library

Complete developer workflow toolkit. Includes 34 reference skills, 34 specialized agents, and 21 slash commands covering TDD, debugging, code review, architecture, documentation, refactoring, security, testing, git workflows, API design, performance, UI/UX design, plugin development, and incident response. Full SDLC coverage with MCP integrations.

Stats

Version1.1.1

Stars1

MaintenanceExcellent

LicenseMIT

AddedJan 22, 2026

Actions

View on GitHub View README Plugin Marketplace JSON

Available In

claudikins-marketplace13

Github Readme for Perfectionists

ESLint for prose. A Claude Code plugin that treats "delve" as a syntax error.

Before:

~~This library provides a seamless way to delve into documentation generation, unleashing the full potential of your README workflow.~~

After:

This plugin generates README files. It bans 15 filler words, enforces sentence patterns that require specifics, and includes humanisation patterns to make AI text sound human.

Quick Start

Install via Claude Code Plugin:

# Add the Claudikins marketplace
/marketplace add aMilkStack/claudikins-marketplace

# Install the plugin
/plugin install claudikins-grfp

Then ask Claude to write a README. The plugin triggers and runs you through 5 phases.

How It Works

flowchart LR
    A["/deep-dive"] --> B["/crystal-ball"]
    B --> C["/brain-jam"]
    C --> D["/think-tank"]
    D --> E["/pen-wielding"]

    A -.- A1["Facts: Stack, structure, friction"]
    B -.- B1["Future: Roadmap, tech debt"]
    C -.- C1["Voice: Angle, tone"]
    D -.- D1["Research: Patterns, badges"]
    E -.- E1["Output: The README"]

What pen-wielding enforces

The final phase applies four governance files:

style-guide.md - Banned words, sentence patterns, humanisation techniques, phrase templates
structural-templates.md - Section ordering by project type, results tables, Do/Don't patterns
visual-engineering.md - Mermaid diagrams, ASCII progress bars, visual density rules
anti-patterns.md - Writing anti-patterns, research anti-patterns, quality checklist

Sentence Patterns

Three patterns you must vary between:

The Hook (Pain → Solution)

Use in: Description, Intro

Before	After
"This library helps with JSON parsing issues."	"JSON logs are unreadable. Kinesis parses them instantly."

The Hammer (Fact + Metric)

Use in: Features, Performance

Before	After
"The system is designed to be incredibly fast."	"Builds finish in under 200ms."

The Trust Builder (Constraint + Fallback)

Use in: Usage, Technical sections

Before	After
"Works perfectly on all platforms."	"Uses `epoll` on Linux; falls back to `kqueue` on macOS."

Humanisation Patterns

Write TO readers, not AT them.

Weak	Strong	Why
"Users can optionally configure..."	"Configure your preferences in..."	Direct address over passive
"The system enables..."	"This helps you..."	Human over system
"Consider implementing..."	"Implement..."	Commands over suggestions
"We achieved 2.4M reach"	"We reached 2.4M people, 20% above target"	Context makes numbers meaningful

ASCII Visualisations

For lightweight progress and status without images.

claudikins-grfp

Component Overview

Install

Component Details

Commands (6)

Skills (6)

README

Github Readme for Perfectionists

Quick Start

How It Works

What pen-wielding enforces

The Hook (Pain → Solution)

The Hammer (Fact + Metric)

The Trust Builder (Constraint + Fallback)

Status Indicators

Similar Plugins

vibeworks-library

claudikins-grfp

Component Overview

Install

Component Details

Commands (6)

Skills (6)

README

Github Readme for Perfectionists

Quick Start

How It Works

What pen-wielding enforces

The Hook (Pain → Solution)

The Hammer (Fact + Metric)

The Trust Builder (Constraint + Fallback)

Status Indicators

Similar Plugins

vibeworks-library

context7-plugin

deep-wiki

claude-obsidian

c4-architecture

documentation-generator