README.md

Node.js Package Template

A template for creating Node.js packages @ we are.

:description

💾 Installation

You can use your package manager (npm or yarn) to install:

npm install --save @weare/:package

or

yarn add @weare/:package

🔌 Getting started

:examples

Development

📄 Makefile

The Makefile is used to create easy-to-use commands. Instead of adding complex commands (with a lot of parameters etc.) to this README, add a simpler version to this README file making use of the Makefile.

⚙️ Install

To install the dependencies:

make install

💯 Tests

To run the tests:

make tests

🚨 Lint

To lint your code:

make lint