Steps after creating a repo with this template
- Find and replace all instances of
template
with the package name. - remove
true ||
from workflows - Ensure branch protection is on
- Enable Codecov for the repository
- Remove this section from the README
Description
A description of the package.
Read Full Documentation here.
Features
- Written In Typescript
- Offers CJS, ESM and UMD builds
- Full TypeScript & JavaScript support
Install
# npm
# TODO: change name
npm i template
# yarn
yarn add template
Usage
Note: While examples uses import
, it maps 1:1 with CommonJS' require syntax. For example, import { package } from 'package-name'
is the same as const { mahrin } = require('template')
.
import { mahrin } from 'template';
Some contents goes here //TODO
Buy me some doughnuts
If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!
✨
Contributors Thanks goes to these wonderful people (emoji key):
Parbez |
WhiteSource Renovate |
This project follows the all-contributors specification. Contributions of any kind welcome!