template

Package Name

Friendly description of the package.

Usage

package-name does this cool thing. You want it because of these excellent reasons.

Basic code example showing simple usage:

import { component } from "package-name";

component.action();

More advanced code example with some fancy usage:

import { component, fancy } from "package-name";

const preliminary = fancy({
    doThing: true,
});

component.fancyAction({
    doOtherThing: preliminary,
});

Ideally here there would be a longer inline list, list of sections, or table of the full features.

Development

Requires:

• Node.js >14 (LTS)
• Yarn

After forking the repo from GitHub:

git clone https://github.com/<your-name-here>/package-name
cd package-name
yarn
yarn run verify

yarn run verify will run a full build and set up the package to be consumed locally.

Contribution Guidelines

We'd love to have you contribute! Check the issue tracker for issues labeled Accepting PRs to find bug fixes and feature requests the community can work on. If this is your first time working with this code, the Good First issue label indicates good introductory issues.

Please note that this project is released with a Contributor Covenant. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT.md.