polymorphic-create-readme-md/README.md

A modern TypeScript tool to generate professional README.md files based on your project structure and scripts.

# Polymorphic Create README MD

🚀 **A modern TypeScript CLI tool to generate professional README.md files based on your project structure and scripts.**

[![npm version](https://img.shields.io/npm/v/polymorphic-create-readme-md.svg)](https://www.npmjs.com/package/polymorphic-create-readme-md)
[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)

## 📋 Table of Contents

- [About](#about)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Configuration](#configuration)
- [Templates](#templates)
- [Development](#development)
- [License](#license)

## 🎯 About

**Polymorphic Create README MD** is a powerful command-line tool that automatically analyzes your project structure and generates professional README.md files. The tool supports various package managers (npm, yarn, pnpm, bun) and creates structured documentation with minimal effort.

## ✨ Features

- 🔍 **Automatic project structure analysis** - scans files and folders with configurable depth
- 📦 **Package manager detection** - automatically detects npm, yarn, pnpm, or bun
- 📝 **Script analysis** - extracts and documents all available npm scripts
- 🎨 **Professional templates** - ready-made templates for beautiful formatting
- 🎯 **TypeScript** - written in TypeScript for reliability and type safety
- 🚀 **CLI tool** - easily integrates into your workflow

## 📦 Installation

### Global Installation

```bash
npm install -g polymorphic-create-readme-md
```

### Local Installation

```bash
npm install --save-dev polymorphic-create-readme-md
```

## 🚀 Usage

### Global Usage

```bash
create-readme
```

### Local Usage

```bash
npx create-readme
```

### In package.json

```json
{
  "scripts": {
    "generate-readme": "create-readme"
  }
}
```

Then run:
```bash
npm run generate-readme
```

## ⚙️ Configuration

When you run the tool, you'll be prompted to fill in the following fields:

- **Project name** - project name (default: current folder name)
- **Project description** - project description (default: "A modern web application")
- **Repository URL** - repository URL (GitHub, GitLab, Bitbucket, etc.)
- **Scan depth** - project structure scan depth (1-10 levels, default: 4) - after scanning you get the structures listed below. 

*Project Structure*
```
polymorphic-create-readme-md/
├── src/
│   ├── constants/
│   │   ├── answers.constants.ts
│   │   └── index.ts
│   ├── helpers/
│   │   ├── get-current-date.ts
│   │   └── index.ts
│   ├── services/
│   │   ├── scripts-analyzer.service.ts
│   │   ├── structure-analyzer.service.ts
│   │   ├── template-engine.service.ts
│   │   └── index.ts
│   ├── templates/
│   │   ├── features.md
│   │   ├── footer.md
│   │   ├── getting-started.md
│   │   ├── header.md
│   │   └── scripts.md
│   ├── types/
│   │   ├── constants/
│   │   │   └── answers.types.ts
│   │   ├── services/
│   │   │   ├── scripts-analyzer.types.ts
│   │   │   ├── structure-analyzer.types.ts
│   │   │   └── template.engine.types.ts
│   │   └── index.ts
│   ├── utils/
│   │   ├── analyzers.utils.ts
│   │   └── index.ts
│   └── index.ts
├── package.json
├── tsconfig.json
└── README.md
```


## 📝 Templates

The tool uses a modular template system:

- **header.md** - header and project structure
- **getting-started.md** - installation and setup instructions
- **scripts.md** - available scripts documentation
- **features.md** - features description
- **footer.md** - additional information

All templates support variables and conditional logic.


## 🤝 Supported Package Managers

- **npm** - `npm install`
- **yarn** - `yarn install`
- **pnpm** - `pnpm install`
- **bun** - `bun install`

## 📄 License

This project is licensed under the ISC License.

## 👨‍💻 Author

**suren-polymorphic**