# progress-events <!-- omit in toc -->

[![codecov](https://img.shields.io/codecov/c/github/achingbrain/progress-events.svg?style=flat-square)](https://codecov.io/gh/achingbrain/progress-events)
[![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/progress-events/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/achingbrain/progress-events/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> Progress events and types

## Table of contents <!-- omit in toc -->

- [Install](#install)
  - [Browser `<script>` tag](#browser-script-tag)
- [API Docs](#api-docs)
- [License](#license)
- [Contribution](#contribution)

## Install

```console
$ npm i progress-events
```

### Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `ProgressEvents` in the global namespace.

```html
<script src="https://unpkg.com/progress-events/dist/index.min.js"></script>
```

## API Docs

- <https://achingbrain.github.io/progress-events>

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.