# ISO UCAN
[![tests](https://img.shields.io/github/actions/workflow/status/substrate-system/iso-ucan/nodejs.yml?style=flat-square)](https://github.com/substrate-system/iso-ucan/actions/workflows/nodejs.yml)
[![types](https://img.shields.io/npm/types/@substrate-system/icons?style=flat-square)](README.md)
[![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)
[![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&style=flat-square)](https://semver.org/)
[![Common Changelog](https://nichoth.github.io/badge/common-changelog.svg)](./CHANGELOG.md)
[![install size](https://flat.badgen.net/packagephobia/install/@substrate-system/iso-ucan)](https://packagephobia.com/result?p=@substrate-system/iso-ucan)
[![gzip size](https://img.shields.io/bundlephobia/minzip/@substrate-system/iso-ucan?style=flat-square)](https://bundlephobia.com/@substrate-system/iso-ucan)
[![dependencies](https://img.shields.io/badge/dependencies-zero-brightgreen.svg?style=flat-square)](package.json)
[![license](https://img.shields.io/badge/license-Big_Time-blue?style=flat-square)](LICENSE)


UCANs

This is a fork of [hugomrdias/iso-ucan](https://github.com/hugomrdias/iso-repo/tree/main/packages/iso-ucan).


<details><summary><h2>Contents</h2></summary>

<!-- toc -->

- [Install](#install)
- [API](#api)
  * [ESM](#esm)
  * [Common JS](#common-js)
- [use](#use)
  * [JS](#js)
  * [pre-built JS](#pre-built-js)

<!-- tocstop -->

</details>

## Install

```sh
npm i -S @substrate-system/iso-ucan
```

## API

This exposes ESM and common JS via [package.json `exports` field](https://nodejs.org/api/packages.html#exports).

### ESM
```js
import '@substrate-system/iso-ucan'
```

### Common JS
```js
require('@substrate-system/iso-ucan')
```

## use

### JS
```js
import '@substrate-system/iso-ucan'
```

### pre-built JS
This package exposes minified JS files too. Copy them to a location that is
accessible to your web server, then link to them in HTML.

#### copy
```sh
cp ./node_modules/@substrate-system/iso-ucan/dist/module.min.js ./public
```

#### HTML
```html
<script type="module" src="./module.min.js"></script>
```