diff options
Diffstat (limited to 'docs/JavaScript.md')
-rw-r--r-- | docs/JavaScript.md | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/JavaScript.md b/docs/JavaScript.md index 4b6a90b..5e7bdc0 100644 --- a/docs/JavaScript.md +++ b/docs/JavaScript.md @@ -1,4 +1,4 @@ -# TODO +# Locusts [![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/locusts?logo=npm&label=NPM%20Package)](https://www.npmjs.com/package/locusts) @@ -6,3 +6,24 @@ [![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) +## Description + +Locusts is a series of libraries that allows you to introduce locusts into your codebase. +Why would you want to do that? I don't know. + +## Installation + +```sh +npm add locusts +``` + +## Example + +```javascript +import introduceLocusts from 'locusts'; + +function main() { + introduceLocusts(); + // Locusts are now in your codebase! +} +``` |