create-node-lib/README.md

Scaffolding out a Node.js library module

<p align="center"><h1 align="center">
  create-node-lib
</h1>

<p align="center">
  Scaffold a batteries-included Node.js library project with docs, tests, semantic releases and more
</p>

<p align="center">
  <a href="https://www.npmjs.org/package/create-node-lib"><img src="https://badgen.net/npm/v/create-node-lib"alt="npm version"/></a>
  <a href="https://www.npmjs.org/package/create-node-lib"><img src="https://badgen.net/npm/license/create-node-lib"alt="license"/></a>
  <a href="https://www.npmjs.org/package/create-node-lib"><img src="https://badgen.net/npm/dt/create-node-lib"alt="downloads"/></a>
  <a href="./SECURITY.md"><img src="https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg" alt="Responsible Disclosure Policy" /></a>
  <a href="https://github.com/saojs/awesome-sao"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome"/></a>
</p>

# About

Scaffold a batteries-included Node.js library project with docs, tests, semantic releases and more.

# Install

Generate a new project for the library by running one of the following:

```bash
npx create-node-lib my-cool-lib-name
```

or if you're using pnpm

```bash
pnpm create node-lib my-cool-lib-name
```

<img alt="Israel Rail API and CLI using npx and npm" src="https://github.com/user-attachments/assets/48ce8c3b-e56f-44a5-9d87-911c34eae43b" />


# Contributing

Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.

# Author

**create-node-lib** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.

## Documentation

- [Project documentation](./docs/README.md) - development, testing, architecture, and conventions.