readmecraft-ai

AI-powered README Engineering Toolkit — scan, generate, sync, and maintain project documentation automatically

Overview

readmecraft-ai is an AI-powered README Engineering Toolkit — scan, generate, sync, and maintain project documentation automatically.

This README provides an overview of the project architecture, setup instructions, and available commands.

Features

• Comprehensive test suite

Tech Stack

| Technology | Category | Version | |------------|----------|---------| | Playwright | Testing | ^1.61.0 | | Vite | Bundler | ^2.1.0 |

Installation

Global install (recommended)

npm install -g readmecraft-ai

Then run from any project:

docp scan
docp generate

Run directly with npx

npx readmecraft-ai scan
npx readmecraft-ai generate --no-ai

Prerequisites

• Node.js >= 20.0.0
• npm (comes with Node.js)

Folder Structure

docpilot/
│   ├── src/
│   │   │   ├── openai.provider.ts
│   │   │   ├── prompts.ts
│   │   │   ├── provider.ts
│   │   │   └── template.provider.ts
│   │   ├── analyzers/
│   │   ├── cli/
│   │   │   │   ├── doctor.ts
│   │   │   │   ├── generate.ts
│   │   │   │   ├── scan.ts
│   │   │   │   ├── score.ts
│   │   │   │   ├── suggest.ts
│   │   │   │   ├── sync.ts
│   │   │   │   └── watch.ts
│   │   │   └── index.ts
│   │   ├── config/
│   │   ├── core/
│   │   │   ├── errors.ts
│   │   │   ├── registry.ts
│   │   │   ├── schemas.ts
│   │   │   └── types.ts
│   │   ├── generators/
│   │   │   │   ├── contributing.ts
│   │   │   │   ├── deployment.ts
│   │   │   │   ├── env-vars.ts
│   │   │   │   ├── features.ts
│   │   │   │   ├── folder-tree.ts
│   │   │   │   ├── installation.ts
│   │   │   │   ├── license.ts
│   │   │   │   ├── overview.ts
│   │   │   │   ├── scripts.ts
│   │   │   │   ├── tech-stack.ts
│   │   │   │   └── types.ts
│   │   │   ├── templates/
│   │   │   └── index.ts
│   │   ├── scanners/
│   │   │   ├── config-file.scanner.ts
│   │   │   ├── env-var.scanner.ts
│   │   │   ├── folder-tree.scanner.ts
│   │   │   ├── framework.ts
│   │   │   ├── git.scanner.ts
│   │   │   ├── index.ts
│   │   │   ├── package.scanner.ts
│   │   │   └── script.scanner.ts
│   │   ├── sync/
│   │   ├── utils/
│   │   │   ├── logger.ts
│   │   │   └── markdown.ts
│   │   ├── verifier/
│   │   ├── watcher/
│   │   └── index.ts
│   ├── tests/
│   │   │   ├── next-fullstack/
│   │   │   └── node-express/
│   │   ├── integration/
│   │   └── unit/
│   │       ├── core/
│   │       ├── generators/
│   │       ├── quality/
│   │       ├── scanners/
│   │       └── sync/
│   ├── .env.example
│   ├── .gitignore
│   ├── package-lock.json
│   ├── package.json
│   ├── README.md
│   ├── tsconfig.json
│   └── vitest.config.ts

Scripts

| Command | Description | |---------|-------------| | build | Build the project for production | | dev | Start development server | | start | Start the application | | test | Run tests | | test:watch | Run tests in watch mode | | test:coverage | Run tests with coverage report | | typecheck | Run TypeScript type checking | | prepublishOnly | npm run build |

Environment Variables

No environment variables detected.

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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