auto-readme-cli/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.1.0] - 2024-01-15

Added

• Initial release of Auto README Generator CLI
• Project structure analysis
• Multi-language support (Python, JavaScript, Go, Rust)
• Dependency detection from various format files
• Tree-sitter based code analysis
• Jinja2 template system for README generation
• Interactive customization mode
• GitHub Actions workflow generation
• Configuration file support (.readmerc)
• Comprehensive test suite

Features

• Automatic README.md generation
• Support for multiple project types
• Configurable templates
• Interactive prompts
• Git integration
• Pretty console output with Rich

Supported File Types

• Python: .py, .pyi files
• JavaScript: .js, .jsx, .mjs, .cjs files
• TypeScript: .ts, .tsx files
• Go: .go files
• Rust: .rs files

Dependency Parsers

• requirements.txt
• pyproject.toml
• package.json
• go.mod
• Cargo.toml