react-animarker/README.md

Animated mark tags on scroll

# React Animarker

![Tests CI](https://github.com/keznet/react-animarker/actions/workflows/tests.yml/badge.svg)

Animarker is a \<mark\> component that animates once in the viewport.

## Getting Started

**Installation**

```
npm i react-animarker
```

Or, if you are using yarn:

```
yarn add react-animarker
```

**Usage**

Import the component and use it as a regular mark tag. Eg.:

```js
import { Animarker } from "react-animarker";
```

**Types**

React Animarker was built on Typescript, so types are included in the package without the need to add extra types.