aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/react/README.md
blob: 39a04eb6f1ece9b2e91576c20e6ed1827475df3e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# @locusts/react

[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/node.yml)
[![NPM Version](https://img.shields.io/npm/v/%40locusts%2Freact?logo=react)](https://www.npmjs.com/package/@locusts/react)

## Description

@locusts/react is a member of a [series of components](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your website.

Why would you want to do that? I don't know.

## Installation

```bash
npm install -D @locusts/react
```

## Usage

```tsx
import { Locusts } from "@locusts/react";

export default function App() {
  return <Locusts />;
}
```