aboutsummaryrefslogtreecommitdiffstats
path: root/docs/JavaScript.md
blob: 5e7bdc0e28e4eb6d0030bbd6ab925464da7ff7ad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# 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)

[![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!
}
```