https://github.com/houkasaurusrex/module-boilerplate

Boilerplate for writing node modules
https://github.com/houkasaurusrex/module-boilerplate

Last synced: 4 months ago
JSON representation

Boilerplate for writing node modules

• Host: GitHub
• URL: https://github.com/houkasaurusrex/module-boilerplate
• Owner: HoukasaurusRex
• License: mit
• Created: 2019-06-15T10:47:59.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-15T10:58:56.000Z (about 7 years ago)
• Last Synced: 2025-10-12T07:55:35.469Z (9 months ago)
• Size: 16.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Module Boilerplate

[![NPM Total Downloads](https://img.shields.io/npm/dt/module-boilerplate.svg)](https://www.npmjs.com/package/module-boilerplate)

[![David Dependencies Status](https://david-dm.org/pterobyte/module-boilerplate.svg)](https://david-dm.org/pterobyte/module-boilerplate)

[![devDependencies Status](https://david-dm.org/pterobyte/module-boilerplate/dev-status.svg)](https://david-dm.org/pterobyte/module-boilerplate?type=dev)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Pterobyte/module-boilerplate.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Pterobyte/module-boilerplate/context:javascript)

[![prs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/pterobyte/module-boilerplate/master)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Brief description or tagline

![screenshots](assets/npm.jpg)

Explanation and purpose of module

## Contents  

- [Getting Started](#getting-started)

- [API Reference](#api-reference)

  - [apiName](#apiName)

- [Examples](#examples)

- [Limitations](#limitations)

- [Contributing](#contributing)

- [Authors](#authors)

- [License](#license)

- [Acknowledgments](#acknowledgments)

## Getting Started

### Install

- With NPM

  ```sh

  npm install module-boilerplate

  ```

- With Yarn

  ```sh

  yarn add module-boilerplate

  ```

## API Reference

### apiName

#### Parameters

Parameter        | Type                          | Description                                 | Example                          |

|--------------  |-----------------------------  |---------------------------------------------|--------------------------------- |

#### Returns

## Examples

```js

`show some code`

```

## Limitations

## Contributing

Please read [CONTRIBUTING.md](https://github.com/pterobyte/module-boilerplate/.github/CONTRIBUTING.md/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

- **JT Houk** - [Pterobyte](https://github.com/pterobyte)

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/pterobyte/module-boilerplate/LICENSE) file for details

## Acknowledgments

The people or projects who helped or inspired this module