Community Plugin

claudikins-grfp

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.

1.1.1

Updated 1 month ago

AI Insight

A structured plugin that guides AI through five phases to generate high-quality, human-sounding READMEs, enforcing strict writing rules to eliminate AI filler.

Why this plugin

Replaces generic AI documentation with specific, humanized prose using a multi-phase process and strict style governance, solving the problem of bland, uninformative READMEs.

Prerequisites

Requires Claude Code, access to the Claudikins marketplace, and optionally Gemini API for the brainstorming phase.

documentation

readme

writing

Install

Add the repository(one-time)

/plugin marketplace add elb-pr/claudikins-github-readme-for-perfectionists

Install the plugin

/plugin install claudikins-grfp@claudikins-marketplace

Components

Commands

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

/brain-jam

4 tools

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

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

/crystal-ball

7 tools

Stage 2 - Envision what this project COULD become

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

/deep-dive

6 tools

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

claudikins-github-readme-for-perfectionists:grfp

/grfp

8 tools

Begin README creation workflow or check current progress and missed areas

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

/pen-wielding

6 tools

Stage 5 - Write the complete README with all insights combined

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

/think-tank

6 tools

Stage 3 - Research how similar projects nail their READMEs

Skills

brain-jam

inherits

1 assets

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

crystal-ball

inherits

1 assets

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

inherits

1 assets

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

inherits

1 assets

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

inherits

4 assets

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

inherits

3 assets

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

Stats

Stars1

MaintenanceExcellent

Last Commit1 month ago

Community Promotion

Collections

Links

View on GitHub

View README

Plugin Marketplace JSON

Similar Plugins

context7-plugin

47.0k

Upstash Context7 MCP server for up-to-date documentation lookup. Pull version-specific documentation and code examples directly from source repositories into your LLM context.

1mo

v@upstash/context7-mcp@2.1.2

c4-architecture

30.0k

Comprehensive C4 architecture documentation workflow with bottom-up code analysis, component synthesis, container mapping, and context diagram generation

v1.0.0

voltagent-dev-exp

10.9k

Tooling and developer productivity experts - CLI tools, documentation, DX optimization

v1.0.1

gitlab

9.1k

GitLab DevOps platform integration. Manage repositories, merge requests, CI/CD pipelines, issues, and wikis. Full access to GitLab's comprehensive DevOps lifecycle tools.

3mo

v1.0.0