README.md

lib-name

Lib Description

Installation

Note: this library needs Node.js and a console you can type in commands (PowerShell on Windows, Terminal on macOS and your favorite terminal emulator on every other OS). The minimum required version of Node.js is: 8 - codename "Carbon".

In your console, run the following command:

$ npm install lib-name

You can also use yarn (like we do in this project):

$ yarn add lib-name

Usage

The library exports a module/function/class.

You can find usage examples in the examples directory.

API

API surface

Related