piez/README.md

Simple mobile browser library for toggling vibration.

# Piez

> A library to help with persistent vibrations on mobile

[![npm version](https://badgen.net/npm/v/piez)](https://www.npmjs.com/package/piez)
[![Known Vulnerabilities](https://snyk.io/test/github/goatandsheep/piez/badge.svg)](https://snyk.io/test/github/goatandsheep/piez)
[![codecov](https://badgen.net/codecov/c/github/goatandsheep/piez)](https://codecov.io/gh/goatandsheep/piez)
[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
[![npm downloads](https://img.shields.io/npm/dt/piez.svg?style=flat-square)](https://www.npmjs.com/package/piez)

## Node installation

```shell
npm i piez
```

## Example

```javascript
import {
	isVibrating,
	startVibrate,
	stopVibrate,
	toggleVibrate
} from 'piez'
```

## Credit

Inspired by [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API#continued_vibrations)

Brought to you by [beatcaps.io](https://www.beatcaps.io)