[Project name]

How to use this template

Fill in each section and delete the ones your project doesn't need. Replace every <placeholder> in the code, and paste a command in only after you've run it.

When it's done, delete this box and the checklist at the end, export the document as Markdown, and save it as README.md at the root of the repository.

What it does and who it's for, in one sentence.

  • Status:

  • Latest release:

  • Runs on:

  • License:

  • Maintainers:

Overview

The problem it solves, and how it differs from the obvious alternative.

Features

Requirements

The runtime and its minimum version, supported systems, anything installed separately.

Installation

Install:

npm install <package-name>

Check that it worked:

<package-name> --version

One-time setup:

Quick start

The smallest example that does something useful.

<package-name> <subcommand> <arguments>

Output:

<what it prints, copied from a real run>

Configuration

Settings are read from:

Setting

Default

What it does

Documentation

  • Tutorial:

  • How-to guides:

  • Reference:

  • Changelog:

Getting help

  • Questions:

  • Bugs: open an issue at [link]. Include your version, the command you ran and its full output.

  • Security problems:

Contributing

Whether you take pull requests, and what makes one easy to merge.

To set up a development copy and run the tests:

git clone https://github.com/<owner>/<repository>.git
cd <repository>
npm install
npm test

See CONTRIBUTING.md for the full guidelines.

License

[License name] © [Year] [Copyright holder]. The full text is in the LICENSE file.

Before you publish

  • Every command was run from a fresh clone, on a machine that didn't have the project yet

  • The version and date match the latest release

  • Every link opens, and none points at a private page

  • The license here matches the LICENSE file

  • Every section is filled in or deleted, and every <placeholder> in the code is replaced