![Typecadence](https://typecadence.colemarshall.net/images/typecadence_logo.svg)

![NPM License](https://img.shields.io/npm/l/typecadence?style=for-the-badge)
![NPM Version](https://img.shields.io/npm/v/typecadence?style=for-the-badge)
![NPM Downloads](https://img.shields.io/npm/dt/typecadence?style=for-the-badge)
![GitHub Repo stars](https://img.shields.io/github/stars/ccmars/typecadence?style=for-the-badge)
![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/ccmars/typecadence/dist%2Ftypecadence.js?style=for-the-badge)

# Typecadence
A JavaScript typing-animation library that automatically mimics the flaws of a human typist.

![Typecadence Demo](https://typecadence.colemarshall.net/images/demo.gif)

## Quick Start
Include the latest version of the Typecadence v1 script in your HTML file:
```html
<script src="https://cdn.jsdelivr.net/npm/typecadence@^1"></script>
```

Add the `typecadence` class to any element you want to animate:
```html
<span class="typecadence">
    Jackdaws love my big sphinx of quartz.
</span>
```

## Documentation
For more options and examples, see the [documentation](https://typecadence.colemarshall.net/).