universal-speedtest/README.md

Test your network speed using Ookla speedtest.

# Universal Speedtest

<hr>
<div>
    <img src="https://img.shields.io/github/actions/workflow/status/karelkryda/universal-speedtest/development.yml?branch=development&label=Dev CI/CD&logo=github&style=for-the-badge" alt="Development CI/CD">
</div>
<div>
    <img src="https://img.shields.io/npm/v/universal-speedtest?logo=npm&style=for-the-badge" alt="Npm version">
    <img src="https://img.shields.io/github/languages/code-size/karelkryda/universal-speedtest?logo=npm&style=for-the-badge" alt="Code size">
    <img src="https://img.shields.io/npm/dw/universal-speedtest?logo=npm&style=for-the-badge" alt="Downloads">
</div>
<div>
    <img src="https://img.shields.io/github/issues/karelkryda/universal-speedtest?logo=github&style=for-the-badge" alt="Github issues">
    <img src="https://img.shields.io/github/stars/karelkryda/universal-speedtest?logo=github&style=for-the-badge" alt="Github stars">
    <img src="https://img.shields.io/github/license/karelkryda/universal-speedtest?logo=github&style=for-the-badge" alt="License">
</div>
<hr>

The Universal Speedtest library allows you to measure the speed of your internet connection using Ookla speedtest.

## 🔧 Installation

### Latest release

```bash
$ npm install --save universal-speedtest
```

### Latest development build

```bash
$ npm install --save github:karelkryda/universal-speedtest#build
```

## 📗 Documentation

The official documentation can be found [here](https://karel-kryda.gitbook.io/universal-speedtest/v/3).