diff options
Diffstat (limited to 'docs/JavaScript.md')
-rw-r--r-- | docs/JavaScript.md | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/docs/JavaScript.md b/docs/JavaScript.md index 52e116b..3f9d787 100644 --- a/docs/JavaScript.md +++ b/docs/JavaScript.md @@ -1,4 +1,32 @@ -# TODO +# Locusts -[![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) +[![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 member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase. + +## Installation + +```sh +npm add locusts +``` + +## Example + +```javascript +import introduceLocusts from "locusts"; + +function main() { + introduceLocusts(); + // Locusts are now in your codebase! +} +``` + +## License + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](https://github.com/locusts-r-us/locusts/blob/master/LICENSE) file for details. |