mirror of
https://github.com/jakejarvis/npm-module-template.git
synced 2025-04-26 13:08:27 -04:00
1.3 KiB
1.3 KiB
Universal JS Boilerplate
Just a personal boilerplate to my liking for an Node and/or browser module w/ ESM, CommonJS, and UMD outputs via Babel & Rollup. Ready to publish on NPM and/or GitHub Packages and distibute via unpkg, skypack.dev, etc.
Probably not very useful to anybody else. 😊
The rest of the readme from now on is placeholder crap...
Install
npm install @jakejarvis/my-module --save-dev
# or...
yarn add @jakejarvis/my-module --dev
Usage
import { something } from "@jakejarvis/my-module";
something({ doSomething: true });
API
something(options?)
options
Type: object
doSomething
Type: boolean
Default: false
Makes it do something.
Examples
License
MIT