Home Reference Source

npm-package-foundation

Skeleton for a simple NPM Package with ES2015 support and CI already configured.

Pre-configured development tools

Pre-configured CI tools

Getting started

  1. Add this project as skeleton remote:
mkdir my-project && cd my-project
git init
git remote add skeleton https://github.com/matejsvajger/npm-package-foundation.git
git remote set-url skeleton --push "Error: skeleton remote is read-only" # Disable pushing on skeleton
git config remote.skeleton.tagOpt --no-tags # Disable fetching tags on skeleton
git remote add origin <YOUR GIT REPOSITORY URL>
git pull skeleton master --no-tags
git push -u origin master

2.

Usage

Automatic releasing process

Note: you can try this process safely by releasing an "alpha" version. Ex: 0.1.0-alpha.2

License

This project is released under MIT License.


Note: the content after this is the actual package documentation (to be edited after cloning).

npm-package-foundation

Latest Stable Version Build Status NPM Downloads

dependencies Status Test Coverage API Documentation

Installation

Prerequisites: Node.js 8+, npm 3+.

npm install --save package-foundation

Usage

ES5

var xxx = require('package-foundation').default;

ES2015+

import xxx from 'package-foundation';

Contributing

Please refer to the guidelines for contributing.

devDependencies Status

License

License