readme-generator

What This Skill Does

The readme-generator skill is an automated documentation engine designed to scan your project's architecture, dependencies, and configuration files to produce a professional-grade README.md. By analyzing files like package.json, pyproject.toml, Dockerfiles, and CI/CD workflows, the agent automatically identifies the framework, necessary installation commands, and run instructions. It constructs a standardized, highly readable README template that ensures your open-source projects or internal tools communicate their purpose, installation process, and configuration details effectively to other developers.

Installation

To integrate this skill into your OpenClaw environment, execute the following command in your terminal: clawhub install openclaw/skills/skills/fratua/readme-generator

Use Cases

• Project Bootstrapping: Quickly generate a professional README for new repositories, ensuring project standards are met from commit zero.
• Legacy Project Documentation: Revive undocumented projects by allowing the agent to infer current requirements and run-scripts from the existing file structure.
• Open Source Contributions: Ensure that your public projects have consistent, high-quality documentation that adheres to industry standards, including license and language badges.

Example Prompts

1. "Analyze this project structure and generate a comprehensive README.md that includes installation instructions and a section for environment variables."
2. "Update my README with the latest project details, detecting my current dependencies and adding relevant badges for license and Node version."
3. "Scan the repository and create a structured README.md, highlighting the deployment steps for my Docker container setup."

Tips & Limitations

• Project Depth: The agent works best when files are organized in standard root-level directories. If your project has a highly non-standard architecture, consider providing extra context to the agent.
• Sensitive Info: The agent reads file content to infer logic. Ensure that your environment variables or sensitive keys are stored in .env files, which are typically ignored by file-scanning logic, but remain vigilant about what is exposed to the agent.
• Refinement: While the output is production-quality, always review the generated README to ensure that the project-specific 'Features' section accurately reflects your intended functionality.