es6-lib-starter-light

ES6 library starter

A light starter for a Node ES6 library.

Quick usage

1. Clone this repo.
2. Change all relevant entries in package.json and README.md, so they match your new shiny library.
3. Run npm install to install dev dependencies.
4. Write your ES6 code in src folder.
5. Write your ES6 tests in test folder.
6. Run npm run build to build for Node. This will compile to ES5 and output the result to lib folder.
7. Run npm publish to pulish to the world.

Detailed overview

Installation

After cloning this repository, make sure to change all the relevant entries in package.json so they match your library.

npm install

Build for npm

npm run build

This will:

1. Convert all files in src folder from ES6 to ES5
2. Output the result to the lib folder

Test

npm run test

Configuration

In package.json, change all the relevant entries so they match your details.
Under main, you can configure library entry point (defaults to ./lib/library.js)

License

MIT