Get started

Installation

How to install Squirrelly for use in Node.js or the browser

Squirrelly tries to follow best practices, and provides a UMD build to support most JS loading options, like ES modules, CommonJS, and AMD.

Install Squirrelly

npm install squirrelly --save

Or if you prefer Yarn:

yarn add squirrelly

Importing / Requiring

Sqrl is packaged as a UMD module, so you can require with CommonJS, import using ES Modules, or use AMD.

import * as Sqrl from 'squirrelly'
// or
var Sqrl = require('squirrelly')

Unpkg

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

JSDelivr

<script src="https://cdn.jsdelivr.net/npm/squirrelly"></script>

This makes Squirrelly available through the global Sqrl variable, and importable using ES modules, CommonJS, and AMD.