# create-read

**Repository Path**: nodets/create-read

## Basic Information

- **Project Name**: create-read
- **Description**: 
A command-line tool to generate README.md files based on package.json and LICENSE files
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-13
- **Last Updated**: 2025-09-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# create-readme.md

[![NPM version](https://img.shields.io/npm/v/create-readme.md.svg?style=flat)](https://www.npmjs.com/package/create-readme.md)
[![License](https://img.shields.io/npm/l/create-readme.md.svg?style=flat)](#)
[![NPM downloads](https://img.shields.io/npm/dm/create-readme.md.svg?style=flat)](https://www.npmjs.com/package/create-readme.md)

A command-line tool to generate README.md files based on package.json and LICENSE files

## Installation

```bash
npm install create-readme.md
```

Or if you want to use it globally:

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

## Usage
```bash
npx create-readme.md
```

Or if installed globally:

```bash
create-readme.md
```


## Available Scripts

- `build`: `tsc`
- `start`: `ts-node src/index.ts`
- `prepublishOnly`: `npm run build`


## Repository

[https://gitee.com/nodets/create-readme.md](https://gitee.com/nodets/create-readme.md)

## Keywords

- readme
- generator
- npm-init
- documentation
- readme-md

## Author

jvy <jvy@qq.com>

## License

MIT License