emoji-mouse-trace/README.md

Trace mouse movement with a trail of emojis or images.

# Emoji Mouse Trace

Trace mouse movement with a trail of emojis or images.

[![License MIT](https://img.shields.io/badge/licence-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
[![Gzip Size](https://img.badgesize.io/https://unpkg.com/emoji-mouse-trace@1.0.0/index.js?compression=gzip)](https://unpkg.com/emoji-mouse-trace@1.0.0/index.js)
[![NPM Package](https://badge.fury.io/js/emoji-mouse-trace.svg)](https://www.npmjs.com/package/emoji-mouse-trace)

## Getting started 🚀
Install the module via npm
```
npm i -s emoji-mouse-trace
```
Call the emojiMouseTrace function within your template or js
```javascript
emojiMouseTrace()
```

## API
| Parameter        | value | default |
| ------------- |:-------------:|:-------------:|
| traceLength      | int | 20 |
| imageSize      | int | 30  |
| images | url | none |
| fadeOut | boolean | false |
| mode | emoji or images | emoji |
| fontFamily | - | Arial |
| fontSize | px | 30px |
| emojis | string | random emojis  |


## Example
```
Just run example.html
```