readme-generate
OfficialAuto-generate module README.md files for Spring Boot.
Authorspring-ai-alibaba
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill automatically generates comprehensive README.md files for Spring Boot modules based on task specification requirements.
Core Features & Use Cases
- Automatically analyzes module controllers, dependencies, and configurations to produce consistent API documentation, usage examples, and testing guidance
- Updates existing READMEs while preserving custom content and adding missing sections
- Generates standardized, cross-module documentation with helpful links to test files and implementation details
Quick Start
Run the generator for a module: python .claude/skills/readme-generate/scripts/readme_generator.py <module_path> [output_file]
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: readme-generate Download link: https://github.com/spring-ai-alibaba/examples/archive/main.zip#readme-generate Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.