README.md Generator

v1.0.4

Generate README.md templates with installation, usage, and contribution sections.

Generates README.md templates with installation, usage, configuration, API reference, contributing, and license sections — fill in your project details and get a formatted Markdown document.

How to use

→Enter your project name, description, and fill in the section fields.
→Toggle sections on/off depending on your project type (library, CLI tool, web app).
→Copy the Markdown and save it as README.md in your project root.

Project Name

Install Command

Description

Features (one per line)

Usage Example

npm badgeCI badgeLicense badge

README.md

[![npm](https://img.shields.io/npm/v/toolkit)](https://npmjs.com/package/toolkit) [![CI](https://github.com/user/repo/actions/workflows/ci.yml/badge.svg)](https://github.com/user/repo/actions) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

# toolkit

A collection of utility helpers for modern JavaScript projects.

## Features

- Zero dependencies
- Tree-shakeable ESM exports
- Full TypeScript support

## Installation

```bash
npm install toolkit
```

## Usage

```bash
import { slugify } from 'toolkit';
slugify('Hello World'); // hello-world
```

## Scripts

- `npm run dev`
- `npm run build`
- `npm run lint`

## Contributing

See CONTRIBUTING.md for contribution workflow.