aboutsummaryrefslogtreecommitdiffstats
path: root/src/packages
diff options
context:
space:
mode:
Diffstat (limited to 'src/packages')
-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