aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/react/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/packages/react/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/packages/react/README.md b/src/packages/react/README.md
new file mode 100644
index 0000000..39a04eb
--- /dev/null
+++ b/src/packages/react/README.md
@@ -0,0 +1,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 />;
+}
+```