From 7b5626744d79586873994705e8bf6cd4f3f3e6cc Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Tue, 29 Oct 2024 11:13:09 -0500 Subject: Make JSR less upset and add a README Signed-off-by: Matt Strapp --- docs/JavaScript.md | 6 +++++- src/packages/locusts/mod.ts | 14 ++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/JavaScript.md b/docs/JavaScript.md index 52e116b..9e3fa70 100644 --- a/docs/JavaScript.md +++ b/docs/JavaScript.md @@ -1,4 +1,8 @@ # TODO [![Node.js](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/locusts?logo=npm&label=NPM%20Package) +[![NPM Version](https://img.shields.io/npm/v/locusts?logo=npm&label=NPM%20Package)](https://www.npmjs.com/package/locusts) + +[![Deno](https://github.com/locusts-r-us/locusts/actions/workflows/deno.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/deno.yml) +[![JSR](https://jsr.io/badges/@locusts-r-us/locusts)](https://jsr.io/@locusts-r-us/locusts) + 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