aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages/react/README.md
diff options
context:
space:
mode:
authorMatthew Strapp <matt@mattstrapp.net>2024-11-01 10:16:44 -0500
committerGitHub <noreply@github.com>2024-11-01 10:16:44 -0500
commit9c3cef2cda489501a177c34ebe47951321284463 (patch)
treea6b45cdef7acde058ee033c386b93fa819e15c36 /src/packages/react/README.md
parentbadge bleach (diff)
downloadlocusts-9c3cef2cda489501a177c34ebe47951321284463.tar
locusts-9c3cef2cda489501a177c34ebe47951321284463.tar.gz
locusts-9c3cef2cda489501a177c34ebe47951321284463.tar.bz2
locusts-9c3cef2cda489501a177c34ebe47951321284463.tar.lz
locusts-9c3cef2cda489501a177c34ebe47951321284463.tar.xz
locusts-9c3cef2cda489501a177c34ebe47951321284463.tar.zst
locusts-9c3cef2cda489501a177c34ebe47951321284463.zip
feat: Add React (#38)
* feat: Add React Closes #35 Signed-off-by: Matt Strapp <matt@mattstrapp.net> * lint Signed-off-by: Matt Strapp <matt@mattstrapp.net> * docs Signed-off-by: Matt Strapp <matt@mattstrapp.net> * lint Signed-off-by: Matt Strapp <matt@mattstrapp.net> * add keywords Signed-off-by: Matt Strapp <matt@mattstrapp.net> --------- Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'src/packages/react/README.md')
-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 />;
+}
+```