README.md

@ionaru/create-package

Description

The purpose of this package is to generate a ready-to-use project for developing NPM packages.

Warning: this package is heavily opinionated and contains multiple hardcoded names and links.

Usage

npx @ionaru/create-package <package-name>

Workflow

Setup

npx @ionaru/create-package <package-name>
cd <package-name>
git remote add origin https://github.com/Ionaru/<package-name>.git
git push -u origin master

Work

// Add code & update changelog
git add .
git commit -m "Work was done"
git push

Release

// Update changelog
git add CHANGELOG.md
git commit -m "Updated changelog for <version>"
npm version <release-type>
git push --follow-tags