📝 ReadMe Generator

A powerful CLI tool for automatically generating comprehensive README files for your projects

📚 Table of Contents

• Description
• Features
• Installation
• Usage
• Roadmap
• FAQ
• License

📖 Description

ReadMe Generator is a sophisticated command-line tool designed to streamline the documentation process for developers. By leveraging advanced AI capabilities from providers like OpenAI and Anthropic, it analyzes your project's structure, code, and dependencies to generate detailed, well-structured README files. The tool supports multiple languages, integrates with both local and GitHub repositories, and provides intelligent context-aware documentation that captures the essence of your project.

Built with TypeScript and modern JavaScript practices, this tool helps solve the common challenge of maintaining high-quality project documentation. Whether you're working on a small personal project or a large open-source initiative, ReadMe Generator helps you create professional documentation that meets industry standards and effectively communicates your project's value to potential users and contributors.

🚀 Features

• ✨ Multi-language support with translations for English, Spanish, French, German, and Russian
• ✨ Seamless integration with both local repositories and GitHub projects
• ✨ AI-powered content generation using OpenAI and Anthropic models
• ✨ Smart project analysis with customizable scan depth
• ✨ Automatic detection and inclusion of technical stack badges
• ✨ Interactive CLI with user-friendly prompts
• ✨ Comprehensive documentation structure with Table of Contents
• ✨ Intelligent roadmap generation with changelog integration
• ✨ Customizable output with support for different file paths

🛠 Installation

1npm install -g @elsikora/readme-generator

💡 Usage

Basic Usage

1# Generate README with interactive prompts
2npx @elsikora/readme-generator generate .
3
4# Generate README for a GitHub repository
5npx @elsikora/readme-generator generate -r owner/repo
6
7# Generate README in a specific language
8npx @elsikora/readme-generator generate . -l ru

Command Line Options

1Options:
2  -r, --repo <path>      Local repo path or GitHub repo (owner/repo)
3  -l, --lang <language>  Documentation language (en, es, fr, de, ru)
4  -d, --scanDepth <n>    Folder scan depth (1-3)
5  -p, --provider         AI provider to use (openai, anthropic)
6  -m, --model           AI model to use
7  -h, --help            Display help information

Environment Configuration

1# Create .env file with your API keys
2ANTHROPIC_API_KEY=your_anthropic_key
3OPENAI_API_KEY=your_openai_key
4GITHUB_TOKEN=your_github_token  # Optional, for private repos

Advanced Usage

Custom Output Location

1# Generate README with a specific output path
2npx @elsikora/readme-generator generate . -o ./docs/README.md

Using with Different AI Models

1# Use specific OpenAI model
2npx @elsikora/readme-generator generate . -p openai -m gpt-4
3
4# Use Anthropic Claude
5npx @elsikora/readme-generator generate . -p anthropic -m claude-3-opus

Integration with CI/CD

1# GitHub Actions example
2steps:
3  - uses: actions/checkout@v2
4  - name: Generate README
5    run: |
6      npm install -g @elsikora/readme-generator
7      readme-generator generate . -l en -d 2
8    env:
9      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

🛣 Roadmap

Task / Feature	Status
Implement multi-file documentation generation	🚧 In Progress
Add support for additional AI providers	🚧 In Progress
Integrate with more version control platforms	🚧 In Progress
Implement template customization	🚧 In Progress
Add support for automated screenshot generation	🚧 In Progress
Create a web interface version	🚧 In Progress
(done) Multi-language support with translations for English, Spanish, French, German, and Russian	🚧 In Progress
(done) Seamless integration with both local repositories and GitHub projects	🚧 In Progress
(done) AI-powered content generation using OpenAI and Anthropic models	🚧 In Progress

❓ FAQ

How does the AI content generation work?

The tool analyzes your project's structure, code, and dependencies, then uses advanced AI models to generate contextually relevant documentation that accurately describes your project.

Which AI providers are supported?

Currently, the tool supports OpenAI (GPT-4) and Anthropic (Claude) models. Additional providers may be added in future updates.

Can I customize the generated README?

Yes, you can modify the output file after generation. Future updates will include template customization features.

Does it work with private GitHub repositories?

Yes, but you'll need to provide a GitHub token with appropriate permissions.

What languages are supported?

The tool currently supports generating documentation in English, Spanish, French, German, and Russian.

🔒 License

This project is licensed under MIT.