ReadMeGen

AI-powered README generator for GitHub repositories.

Installation

npm install -g readmegen

Development Setup

1. Clone the repository

2. Install dependencies:

   npm install

3. Copy .env.example to .env and add your API keys:

   cp .env.example .env

4. Run in development mode:

   npm run dev

5. Build the project:

   npm run build

Usage

# Generate README for current directory
readmegen generate

# Generate with specific options
readmegen generate --provider anthropic --auto

# Preview without writing
readmegen preview

# Configure settings
readmegen config --list

Project Structure

readmegen/
├── src/
│   ├── index.ts              # CLI entry point
│   ├── commands/             # Command implementations
│   ├── analyzer/             # Repository analysis
│   ├── generator/            # README generation with AI
│   ├── utils/                # Utility functions
│   └── ui/                   # UI components
├── dist/                     # Compiled output
└── package.json

TODO

• Implement complete file counting and structure analysis
• Add OpenAI provider support
• Implement configuration storage
• Add better error handling
• Add tests
• Add template system
• Implement Markdown preview in terminal
• Add badge generation
• Add support for multiple languages detection

License

MIT