@zce/create-nm/README.md

A scaffolding tools for creating node modules.

# @zce/create-nm

[![Build Status][actions-img]][actions-url]
[![NPM Downloads][downloads-img]][downloads-url]
[![NPM Version][version-img]][version-url]
[![License][license-img]][license-url]
[![Dependency Status][dependency-img]][dependency-url]
[![devDependency Status][devdependency-img]][devdependency-url]
[![Code Style][style-img]][style-url]

> A scaffolding tool for creating node modules.

## Usage

Prerequisites: [Node.js](https://nodejs.org) (>= 14.14 required, >= 16.13 preferred), [npm](https://www.npmjs.com) (>= 7.x) or [yarn](https://yarnpkg.com) (>= 1.22) and [Git](https://git-scm.com).

Use npm:

```shell
$ npm init @zce/nm <project>
```

Use yarn:

```shell
$ yarn create @zce/nm <project>
```

Use npx:

```shell
$ npx @zce/create-nm <project>
```

Globally install:

```shell
$ npm install @zce/create-nm -g
# or yarn
$ yarn global add @zce/create-nm
```

```shell
$ create-nm <project>
```

## Related

- [zce/caz](https://github.com/zce/caz) - A simple yet powerful template-based Scaffolding tools.
- [caz-templates/nm](https://github.com/caz-templates/nm) - A template for creating node modules.

## Contributing

1. **Fork** it on GitHub!
2. **Clone** the fork to your own machine.
3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
6. Submit a **Pull Request** so that we can review your changes.

> **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!

## License

[MIT](LICENSE) &copy; [zce](https://zce.me)



[actions-img]: https://img.shields.io/github/workflow/status/zce/create-nm/CI
[actions-url]: https://github.com/zce/create-nm/actions
[downloads-img]: https://img.shields.io/npm/dm/@zce/create-nm
[downloads-url]: https://npmjs.org/package/@zce/create-nm
[version-img]: https://img.shields.io/npm/v/@zce/create-nm
[version-url]: https://npmjs.org/package/@zce/create-nm
[license-img]: https://img.shields.io/github/license/zce/create-nm
[license-url]: https://github.com/zce/create-nm/blob/master/LICENSE
[dependency-img]: https://img.shields.io/david/zce/create-nm
[dependency-url]: https://david-dm.org/zce/create-nm
[devdependency-img]: https://img.shields.io/david/dev/zce/create-nm
[devdependency-url]: https://david-dm.org/zce/create-nm?type=dev
[style-img]: https://img.shields.io/badge/code_style-standard-brightgreen
[style-url]: https://standardjs.com