Generate README
Generate comprehensive README documentation for the current project.
Sections to Include
- Project Title & Description
- Clear, concise project description
- Key features and benefits
-
Target audience
-
Installation
- Prerequisites
- Step-by-step installation instructions
-
Common installation issues and solutions
-
Usage
- Basic usage examples
- Common use cases
-
Code snippets with explanations
-
Configuration
- Environment variables
- Configuration files
-
Available options
-
API Documentation (if applicable)
- Endpoint descriptions
- Request/response examples
-
Authentication details
-
Development
- Local setup instructions
- Running tests
- Code style guidelines
-
Contribution guidelines
-
Deployment
- Deployment instructions
- Environment-specific notes
-
CI/CD information
-
License & Credits
- License information
- Contributors
- Acknowledgments
Style Guidelines
- Use clear, concise language
- Include code examples where helpful
- Use proper Markdown formatting
- Add badges for build status, coverage, etc.
- Include table of contents for long READMEs
Focus Area
If $1 is provided, focus on updating/improving that specific section. Otherwise, generate a complete README from scratch.