# jquery-delay-text #

[![npm](https://img.shields.io/npm/l/jquery-delay-text.svg)](https://www.npmjs.com/package/jquery-delay-text/)
[![npm](https://img.shields.io/npm/dt/jquery-delay-text.svg)](https://www.npmjs.com/package/jquery-delay-text)
[![npm](https://img.shields.io/npm/dm/jquery-delay-text.svg)](https://www.npmjs.com/package/jquery-delay-text)

![](example.gif)

## Index ##

* [About](#about)
* [Setup](#setup)
* [Documentation](#documentation)
* [Contributing](#contributing)
* [Issues](#issues)
* [Deploy](#deploy)

## About ## 

A light weight Angular 2+ service for checking internet speed  

* Try out [the demo](https://jquery-delay-text.jrquick.com) to see it in action!
* Visit [my website](https://jrquick.com) for other cool projects!

## Setup ##

### Install ###

### Node ###

```
npm install jquery-delay-text --save
```

### CDN ###

```
<script src="https://cdn.jsdelivr.net/gh/jrquick17/jquery-delay-text/delay-text.js"></script>
```

## Documentation ##

```javascript
$('#text').delayText();
```

### Options ###

* `sequential` -- Reveal text in order (Default: `false`)
* `time` -- Total time to reveal full text (Default: `1000`)

## Contributing ##

### Thanks ###

* [jrquick17](https://github.com/jrquick17)

## Issues ##

If you find any issues feel free to open a request in [the Issues tab](https://github.com/jrquick17/jquery-delay-text/issues). If I have the time I will try to solve any issues but cannot make any guarantees. Feel free to contribute yourself.

## Deploy ##

#### NPM Release ####

* Run `npm run shipit`

#### Update Changelog ####

* Add updates to `CHANGELOG.md` in root.