package_name

---

Few lines describing your project.

📝 Table of Contents

• package_name
  • 📝 Table of Contents
  • 🧐 About
  • Install
    • Package Manager
    • CDN
  • 🔧 Running the tests
  • 🎈 Usage
  • Example
  • 📃 License
  • ✍️ Authors
  • 🔨 Similar Tools

🧐 About

Important but basic info

Install

Package Manager

NPM

npm i package_name

PNPM

pnpm add package_name

Yarn

yarn add package_name

CDN

Skypack

For Web and Deno, no install is required! Just put this line at the top of your file:

import { inflate } from 'https://cdn.skypack.dev/package_name';

If you want type support with skypack, follow the directions here

UNPKG

<script src="https://unpkg.com/package_name"></script>

And use it like you would any other package from UNPKG

🔧 Running the tests

The basic set of tests are in the test script, the coverage script, and the report script. Just run those using your perferred package manager (npm, yarn, pnpm, etc.) to make sure nothing has broken.

🎈 Usage

Here's the great part: thanks to microbundle, this package supports CJS, UMD, and ESM formats. That means that wherever and however you use this package — in browser or node, with import or require — you should be set, no configuration required.

Example

put content here

📃 License

Distributed under the MIT License. See LICENSE for more information.

✍️ Authors

Find me @illumincrotty on github or @illumincrotty on twitter

🔨 Similar Tools

If this tool isn't working for you, try one of these:

• 0
• 1
• 2