write-readme

Generate paired English and Korean README files from Vlossom source code.

3|Updated Mar 12, 2025
One-click install
npx skills add https://github.com/vlossom-ui/vlossom --skill write-readme-vlossom-ui
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-readme
Source: https://github.com/vlossom-ui/vlossom/tree/main/.claude/skills/write-readme
Command: npx skills add https://github.com/vlossom-ui/vlossom --skill write-readme-vlossom-ui

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate paired English and Korean README files from the Vlossom source code.

Core Features & Use Cases

  • Generates both README.md (English) and README.ko.md (Korean) from the Vlossom source.
  • Invoked manually via /write-readme <target> to prevent automatic triggering.
  • Validates outputs using the README_CHECK_LIST to ensure quality and consistency.

Quick Start

Invoke /write-readme with a target path to generate paired READMEs from the Vlossom source.

Frequently Asked Questions about write-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate bilingual README documentation from Vue source code?

Generate bilingual README documentation from Vue source code by invoking the generator with a target path, which reads the source files and automatically produces paired English and Korean README files.

Can I automatically trigger README generation for Vue composables and directives?

README generation for Vue composables and directives is not automatic; it requires manual invocation via a specific command with a target path to prevent unintended execution during development.

How does a README generator ensure documentation quality for components and plugins?

A README generator ensures documentation quality for components and plugins by running a self-verification checklist against an included validation list after generating the paired bilingual files.

What is the best way to maintain up-to-date i18n documentation for a Vue utility library?

Maintain up-to-date i18n documentation for a Vue utility library by manually triggering a generator that creates paired English and Korean README files directly from the current source code.

Does bilingual README generation work for all Vlossom document types?

Bilingual README generation works for all Vlossom document types, including components, plugins, directives, composables, and utilities, producing paired English and Korean outputs.

Why does my README generation fail to update documentation automatically?

README generation fails to update automatically because it is intentionally designed for manual invocation to prevent automatic triggering, requiring you to explicitly run the command with a target path.