aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-10-29 11:13:09 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-10-29 11:13:09 -0500
commit7b5626744d79586873994705e8bf6cd4f3f3e6cc (patch)
tree83c91d667d447d37e039acb3f2f535d2010367c5 /src/packages
parentAdd README to npm file? (diff)
downloadlocusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar.gz
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar.bz2
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar.lz
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar.xz
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.tar.zst
locusts-7b5626744d79586873994705e8bf6cd4f3f3e6cc.zip
Make JSR less upset and add a README
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to '')
-rw-r--r--src/packages/locusts/mod.ts14
1 files changed, 14 insertions, 0 deletions
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