codewithpatelo / npm-package-boilerplate

Npm package boilerplate already integrated with Chai, Eslint, Istambul, Travis, Mocha, Coveralls, a readme file and function skeleton to kick start your npm package project.

	
const yourPackageName = require('yourPackageName');

Project Name

This library helps //developers to //value proposition by //features. The package is the //unique selling point (first, best, optimal in //area that stand out). It can be applied in areas such as //implementation areas , for //use cases.

Installation

npm i project

Example Usage

project.packageFunction();

Returns:

// Something

DEMO

https://runkit.com/user/runkit-npm-project

Documentation

Argument	Description	Mandatory	Type	Rules
1	Description of argument 1	True / False	Type
2	Description of argument 2	True / False	Type
3	Description of argument 3	True / False	Type

Package Dependencies

• package-dependency 1
• package-dependency 2
• package-dependency 3

Package roadmap

• Feature 1.
• Feature 2.
• Feature 3.
• Feature 4.
• Feature 5.
• Feature 6.

License

MIT

Contributing

https://github.com/user/project

Linting

• AIRBNB AIRBNB JS CODE STYLE

Configuration

• Eslint v-4.19.1 // AIRBNB Configuration

Linting scripts

• Error lint: npm run lint
• Error lint-fix: npm run lint-fix or npm run lint -- --fix

Bibliography

• It is always a good practise to support your work with scientific/ademic literature.