From 7b5626744d79586873994705e8bf6cd4f3f3e6cc Mon Sep 17 00:00:00 2001
From: Matt Strapp <matt@mattstrapp.net>
Date: Tue, 29 Oct 2024 11:13:09 -0500
Subject: Make JSR less upset and add a README

Signed-off-by: Matt Strapp <matt@mattstrapp.net>
---
 src/packages/locusts/mod.ts | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src')

diff --git a/src/packages/locusts/mod.ts b/src/packages/locusts/mod.ts
index 6042c3b..0071fb2 100644
--- a/src/packages/locusts/mod.ts
+++ b/src/packages/locusts/mod.ts
@@ -1 +1,15 @@
+/**
+ * This module introduces locusts to your application.
+ *
+ * Why would you want to do that? I don't know, but you can.
+ *
+ * @example
+ * ```typescript
+ * import { introduceLocusts } from "@locusts-r-us/locusts"
+ *
+ * introduceLocusts()
+ * ```
+ * @module
+ */
+
 export * from "./src/index.ts"
\ No newline at end of file
-- 
cgit v1.2.3