Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

NPM Module Package Template
https://github.com/kamescg/module-boilerplate

boilerplate module npm

Last synced: about 2 months ago
JSON representation

NPM Module Package Template

Awesome Lists containing this project

README

        

# module-boilerplate

[![build status](https://img.shields.io/travis/com/KamesCG/module-boilerplate.svg)](https://travis-ci.com/KamesCG/module-boilerplate)
[![code coverage](https://img.shields.io/codecov/c/github/KamesCG/module-boilerplate.svg)](https://codecov.io/gh/KamesCG/module-boilerplate)
[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
[![license](https://img.shields.io/github/license/KamesCG/module-boilerplate.svg)](LICENSE)
[![npm downloads](https://img.shields.io/npm/dt/module-boilerplate.svg)](https://npm.im/module-boilerplate)

> NPM Module Boilerplate

## Table of Contents

* [Install](#install)
* [Usage](#usage)
* [Contributors](#contributors)
* [License](#license)

## Install

[npm][]:

```sh
npm install module-boilerplate
```

[yarn][]:

```sh
yarn add module-boilerplate
```

## Usage

```js
const ModuleBoilerplate = require('module-boilerplate');

const moduleBoilerplate = new ModuleBoilerplate();

console.log(moduleBoilerplate.renderName());
// script
```

## Contributors

| Name | Website |
| --------- | ------------------------- |
| **Kames** | |

## License

[MIT](LICENSE) © [Kames](https://www.kamescg.com)

##

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/