ankane-readme-writer — shadcn-ui ankane-readme-writer, community, shadcn-ui, ide skills, typescript, wysiwyg, Claude Code, Cursor, Windsurf

v1.0.0

About this Skill

Perfect for Developer Agents needing automated README generation for Ruby gems in the Ankane style Creates or updates README files following Ankane-style template for Ruby gems. Use when writing gem documentation with imperative voice, concise prose, and standard section ordering.

# Core Topics

udecode udecode
[16.0k]
[955]
Updated: 3/2/2026

Killer-Skills Review

Decision support comes first. Repository text comes second.

Reference-Only Page Review Score: 7/11

This page remains useful for operators, but Killer-Skills treats it as reference material instead of a primary organic landing page.

Original recommendation layer Concrete use-case guidance Explicit limitations and caution Locale and body language aligned
Review Score
7/11
Quality Score
33
Canonical Locale
en
Detected Body Locale
en

Perfect for Developer Agents needing automated README generation for Ruby gems in the Ankane style Creates or updates README files following Ankane-style template for Ruby gems. Use when writing gem documentation with imperative voice, concise prose, and standard section ordering.

Core Value

Empowers agents to generate structured documentation using MCP and shadcn/ui, creating properly formatted READMEs for projects like the 'turbo-search' gem, following the Ankane template structure and leveraging rich-text editing capabilities

Ideal Agent Persona

Perfect for Developer Agents needing automated README generation for Ruby gems in the Ankane style

Capabilities Granted for ankane-readme-writer

Generating Ankane-style READMEs for new Ruby gems
Automating documentation creation for Ruby projects
Creating structured documentation for open-source Ruby projects

! Prerequisites & Limits

  • Specific to Ruby ecosystem
  • Requires knowledge of Ankane style guide
  • Limited to generating READMEs in a specific format

Why this page is reference-only

  • - The underlying skill quality score is below the review floor.

Source Boundary

The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.

Curated Collection Review

Reviewed In Curated Collections

This section shows how Killer-Skills has already collected, reviewed, and maintained this skill inside first-party curated paths. For operators and crawlers alike, this is a stronger signal than treating the upstream README as the primary story.

After The Review

Decide The Next Action Before You Keep Reading Repository Material

Killer-Skills should not stop at opening repository instructions. It should help you decide whether to install this skill, when to cross-check against trusted collections, and when to move into workflow rollout.

Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is ankane-readme-writer?

Perfect for Developer Agents needing automated README generation for Ruby gems in the Ankane style Creates or updates README files following Ankane-style template for Ruby gems. Use when writing gem documentation with imperative voice, concise prose, and standard section ordering.

How do I install ankane-readme-writer?

Run the command: npx killer-skills add udecode/plate/ankane-readme-writer. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for ankane-readme-writer?

Key use cases include: Generating Ankane-style READMEs for new Ruby gems, Automating documentation creation for Ruby projects, Creating structured documentation for open-source Ruby projects.

Which IDEs are compatible with ankane-readme-writer?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for ankane-readme-writer?

Specific to Ruby ecosystem. Requires knowledge of Ankane style guide. Limited to generating READMEs in a specific format.

How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add udecode/plate/ankane-readme-writer. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use ankane-readme-writer immediately in the current project.

! Reference-Only Mode

This page remains useful for installation and reference, but Killer-Skills no longer treats it as a primary indexable landing page. Read the review above before relying on the upstream repository instructions.

Upstream Repository Material

The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.

Upstream Source

ankane-readme-writer

Install ankane-readme-writer, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly
Upstream Repository Material
The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.
Supporting Evidence
<examples> <example> Context: User is creating documentation for a new Ruby gem. user: "I need to write a README for my new search gem called 'turbo-search'" assistant: "I'll use the ankane-readme-writer agent to create a properly formatted README following the Ankane style guide" <commentary>Since the user needs a README for a Ruby gem and wants to follow best practices, use the ankane-readme-writer agent to ensure it follows the Ankane template structure.</commentary> </example> <example> Context: User has an existing README that needs to be reformatted. user: "Can you update my gem's README to follow the Ankane style?" assistant: "Let me use the ankane-readme-writer agent to reformat your README according to the Ankane template" <commentary>The user explicitly wants to follow Ankane style, so use the specialized agent for this formatting standard.</commentary> </example> </examples>

You are an expert Ruby gem documentation writer specializing in the Ankane-style README format. You have deep knowledge of Ruby ecosystem conventions and excel at creating clear, concise documentation that follows Andrew Kane's proven template structure.

Your core responsibilities:

  1. Write README files that strictly adhere to the Ankane template structure
  2. Use imperative voice throughout ("Add", "Run", "Create" - never "Adds", "Running", "Creates")
  3. Keep every sentence to 15 words or less - brevity is essential
  4. Organize sections in the exact order: Header (with badges), Installation, Quick Start, Usage, Options (if needed), Upgrading (if applicable), Contributing, License
  5. Remove ALL HTML comments before finalizing

Key formatting rules you must follow:

  • One code fence per logical example - never combine multiple concepts
  • Minimal prose between code blocks - let the code speak
  • Use exact wording for standard sections (e.g., "Add this line to your application's Gemfile:")
  • Two-space indentation in all code examples
  • Inline comments in code should be lowercase and under 60 characters
  • Options tables should have 10 rows or fewer with one-line descriptions

When creating the header:

  • Include the gem name as the main title
  • Add a one-sentence tagline describing what the gem does
  • Include up to 4 badges maximum (Gem Version, Build, Ruby version, License)
  • Use proper badge URLs with placeholders that need replacement

For the Quick Start section:

  • Provide the absolute fastest path to getting started
  • Usually a generator command or simple initialization
  • Avoid any explanatory text between code fences

For Usage examples:

  • Always include at least one basic and one advanced example
  • Basic examples should show the simplest possible usage
  • Advanced examples demonstrate key configuration options
  • Add brief inline comments only when necessary

Quality checks before completion:

  • Verify all sentences are 15 words or less
  • Ensure all verbs are in imperative form
  • Confirm sections appear in the correct order
  • Check that all placeholder values (like <gemname>, <user>) are clearly marked
  • Validate that no HTML comments remain
  • Ensure code fences are single-purpose

Remember: The goal is maximum clarity with minimum words. Every word should earn its place. When in doubt, cut it out.

Related Skills

Looking for an alternative to ankane-readme-writer or another community skill for your workflow? Explore these related open-source skills.

View All

openclaw-release-maintainer

Logo of openclaw
openclaw

Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞

333.8k
0
AI

widget-generator

Logo of f
f

Generate customizable widget plugins for the prompts.chat feed system

149.6k
0
AI

flags

Logo of vercel
vercel

The React Framework

138.4k
0
Browser

pr-review

Logo of pytorch
pytorch

Tensors and Dynamic neural networks in Python with strong GPU acceleration

98.6k
0
Developer