Create or update README.md based on project analysis.
Generate or update README.md files by analyzing your project structure and content. Use it to create comprehensive documentation when starting a new project, or update existing READMEs while preserving custom sections.
/plugin marketplace add varaku1012/aditi.code/plugin install auto-docs@aditi-code-pluginsCreate or update README.md based on project analysis.
/docs-readme # Generate new README
/docs-readme --update # Update existing README
/docs-readme --sections features,install # Specific sections
# ProjectName
[]()
[]()
Brief description of what the project does.
## Features
- Feature 1
- Feature 2
- Feature 3
## Quick Start
```bash
# Install
pip install project-name
# Run
python main.py --input "your input"
from project import Pipeline
pipeline = Pipeline(config)
result = await pipeline.run(input_data)
project/
├── pipelines/ # Processing pipelines
├── agents/ # AI agents
├── tools/ # External integrations
└── interfaces/ # Data models
See CONTRIBUTING.md for guidelines.
MIT License - see LICENSE for details.
## Update Mode
With `--update`:
- Preserves custom content
- Updates generated sections
- Adds missing sections
- Maintains formatting
Sections marked with `<!-- AUTO-GENERATED -->` are updated.
Custom sections are preserved.
## Configuration
In `readme.yaml`:
```yaml
sections:
- header
- features
- quick_start
- installation
- usage
- architecture
- contributing
- license
badges:
- license
- python_version
- tests
- coverage
preserve_custom: true