auto-readme

Auto-generate README files for your projects using AI. This tool watches your project files for changes and automatically updates your README with relevant information.

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License

Installation

# Install globally
npm install -g auto-readme

# Or locally in your project
npm install --save-dev auto-readme

Usage

# Initialize configuration
npm run init

# Generate README once
npm run gen

# Watch for changes
npm start

In your project, you can create a custom readme template in templates/readme-template.md. The template uses special tag pairs to define sections that can be automatically updated:

<!-- AUTO-SECTION_NAME -->
Content will be replaced by AI
<!-- /AUTO-SECTION_NAME -->

Sections not defined in autoSections in your config will preserve manual edits.

Example configuration (readme-gen.config.json):

{
  "watchPaths": ["src/**/*", "package.json"],
  "ignorePatterns": ["**/node_modules/**", "**/dist/**"],
  "model": "mixtral-8x7b-32768",
  "templatePath": "./templates/readme-template.md",
  "autoSections": [
    "description",
    "installation",
    "usage",
    "contributing"
  ],
  "debounce": 2000
}

Features

• AI-powered README generation using Groq API
• Watch mode for automatic updates
• Custom templates with manual section preservation
• Rate limiting to prevent API overuse
• Support for multiple AI models
• Project context analysis for relevant documentation

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.