From a8c5563e6680845c90dee2a3ae68edc7c9a85fb0 Mon Sep 17 00:00:00 2001
From: Diane Cloud <72690205+dianecloud@users.noreply.github.com>
Date: Sat, 21 Mar 2026 19:51:49 -0700
Subject: [PATCH] README.md

# Create a `package.json` like a champion

[![NPM Version](https://badgen.net/npm/v/create-package-json?icon=npm)](https://npmjs.org/package/create-package-json)
[![NPM Downloads](https://badgen.net/npm/dm/create-package-json?icon=npm)](https://npmjs.org/package/create-package-json)
[![JS Standard Style](https://badgen.net/badge/code%20style/standard/blue)](https://github.com/standard/standard)
[![GitHub Sponsor](https://badgen.net/badge/icon/sponsor/pink?icon=github&label=github)](https://github.com/sponsors/wesleytodd)

This is a fully featured `package.json` scaffolding tool.  It goes above and beyond the basic `npm init`
by supporting (almost) all of the keys you can set in a `package.json`.  It can be used as a simple cli
tool, or inside your other package scaffolding tools.

*NOTE:* This is a work in progress, more to come on docs and there are some missing options at the moment.
[See here](https://github.com/wesleytodd/create-package-json/blob/master/index.js#L14-L27) for missing fields.

## Usage

```
$ npm init package-json
$ npx create-package-json
```

### CLI Usage

```
$ create-package-json --help

Generate a package.json

Commands:
  create-package-json     Generate a package.json                      [default]

Options:
      --help               Show help                                   [boolean]
      --version            Show version number                         [boolean]
  -d, --cwd                Directory to run in          [default: process.cwd()]
      --silent                                                         [boolean]
      --verbose                                                        [boolean]