template.hbs

# superscript

*A library of miscellaneous JavaScript utilities*

[![npm version](https://img.shields.io/npm/v/supers.svg)](https://npmjs.org/package/supers)
[![Licence](https://img.shields.io/npm/l/supers.svg)](https://github.com/tripu/superscript/blob/master/LICENSE.md)
[![Build Status](https://app.travis-ci.com/tripu/superscript.svg?branch=master)](https://app.travis-ci.com/tripu/superscript)
[![dependencies Status](https://david-dm.org/tripu/superscript/status.svg)](https://david-dm.org/tripu/superscript)
[![devDependencies Status](https://david-dm.org/tripu/superscript/dev-status.svg)](https://david-dm.org/tripu/superscript?type=dev)
[![Coverage Status](https://coveralls.io/repos/github/tripu/superscript/badge.svg?branch=master)](https://coveralls.io/github/tripu/superscript?branch=master)
[![Inline docs](https://inch-ci.org/github/tripu/superscript.svg?branch=master)](https://inch-ci.org/github/tripu/superscript)

**Contents:**

1. [Installation](#1-installation)
1. [Documentation](#2-documentation)
1. [Coming soon](#3-coming-soon)
1. [Contributing](#4-contributing)
1. [Credits](#5-credits)

## 1. Installation

### On the browser

Any of these should work:

* Download [the *browserified* version from GitHub](https://raw.githubusercontent.com/tripu/superscript/master/superscript.js) and load it:  
  `<script src="superscript.js"></script>`
* Load it via [jsDelivr](https://www.jsdelivr.com/):  
  `<script src="https://cdn.jsdelivr.net/npm/supers/superscript.js"></script>`
* Load it via [Unpkg](https://unpkg.com/):  
`<script src="https://unpkg.com/supers/superscript.js"></script>`

### On Node.js

```bash
$ npm i supers
```

```javascript
const superscript = require('supers');
```

## 2. Documentation

{{>main}}

## 3. Coming soon

* `cache()`
* `throttle()`
* `debounce()` (based on [David Walsh' code](https://davidwalsh.name/javascript-debounce-function))

## 4. Contributing

```bash
npm clone https://github.com/tripu/superscript.git
cd superscript
npm i && npm run build
```

## 5. Credits

Copyright &copy; 2017&ndash;2022 tripu ([`t@tripu.info`](mailto:t@tripu.info), [`https://tripu.info`](https://tripu.info/)).

This project is licenced [under the terms of the MIT licence](https://github.com/tripu/superscript/blob/master/LICENSE.md).