@richrdkng/generator-simple-nodejs-project
Version:
A basic Yeoman generator for simple Node.js modules and projects.
47 lines (34 loc) • 2.22 kB
Markdown
# @richrdkng/generator-simple-nodejs-project
[![NPM][badge-npm]][url-npm]
[![CI][badge-ci]][url-ci]
[![Deps][badge-deps]][url-deps]
[![License][badge-license-isc]][url-license-doc]
[![Contrib][badge-contrib]][url-contrib-doc]
A basic, opinionated Yeoman generator **for simple Node.js modules and projects** by [@richrdkng][url-richrdkng].
## Usage
Just simply **copy** and **paste** into the terminal and **execute** it:
```bash
npm i -g @richrdkng/generator-simple-nodejs-project && \
npx yo @richrdkng/simple-nodejs-project && \
npm un -g @richrdkng/generator-simple-nodejs-project
```
The **one-liner**:
```bash
npm i -g @richrdkng/generator-simple-nodejs-project && npx yo @richrdkng/simple-nodejs-project && npm un -g @richrdkng/generator-simple-nodejs-project
```
## License
[ISC][url-license-doc] @ [Richard King][url-richrdkng]
<!--- References ============================================================================ -->
<!--- Badges -->
[badge-npm]: https://img.shields.io/npm/v/@richrdkng/generator-simple-nodejs-project?color=brightgreen&label=NPM&style=flat-square&logo=npm
[badge-ci]: https://img.shields.io/travis/richrdkng/generator-simple-nodejs-project/master?label=Travis%20CI&style=flat-square&logo=travis
[badge-deps]: https://img.shields.io/librariesio/release/npm/@richrdkng/generator-simple-nodejs-project?label=Dependencies%20&style=flat-square&logo=dependabot
[badge-license-isc]: https://img.shields.io/badge/License-ISC-brightgreen.svg?style=flat-square&logo=github
[badge-contrib]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square&logo=github
<!--- URLs -->
[url-npm]: https://www.npmjs.com/package/@richrdkng/generator-simple-nodejs-project
[url-ci]: https://travis-ci.org/richrdkng/generator-simple-nodejs-project
[url-deps]: https://libraries.io/github/richrdkng/generator-simple-nodejs-project
[url-richrdkng]: https://www.richrdkng.com
[url-license-doc]: https://github.com/richrdkng/generator-simple-nodejs-project/blob/master/LICENSE.md
[url-contrib-doc]: https://github.com/richrdkng/generator-simple-nodejs-project/blob/master/.github/CONTRIBUTING.md