KieranGaoKieranGaoCommunity·1 Agent Skills Included

general-readme-skill

Generate professional multi-language README files for any project

Generates polished README files by scanning your project's real code, dependencies, and structure. Applies consistent tone profiles, shields.io badges, Mermaid architecture diagrams, and multi-language versions automatically. Eliminates blank-page writing, placeholder filler, and manual formatting while masking sensitive keys and passwords.
npx skills add KieranGao/general-readme-skill --all -g -y

All Skills in This Repository (1)

Pure Emerald Level Indicators

Frequently Asked Questions

FAQPage Schema
How to install General README Skill?

Run `npx skills add KieranGao/general-readme-skill --all -g -y` in your terminal to install it globally for your coding assistant.

How to generate a README automatically?

Type /readme or say "generate readme" in your coding assistant, and it scans your project files to build a complete, structured README.

Does it work with Claude Code, Copilot, and Cursor?

Yes. The skill follows the standard SKILL.md format and runs natively in Claude Code, GitHub Copilot, Cursor, and other compatible assistants.

Can it create READMEs in multiple languages?

Yes. It generates a primary English README plus secondary versions in Chinese, Japanese, Korean, Russian, and more, with a built-in language switcher.

Will it expose my API keys or passwords?

No. Privacy protection is built in, so sensitive keys, passwords, and private data are automatically masked during generation.

Related Repositories in Content & Communication

View All in Content & Communication