aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/JVM.md2
-rw-r--r--docs/JavaScript.md23
-rw-r--r--docs/Ruby.md25
3 files changed, 48 insertions, 2 deletions
diff --git a/docs/JVM.md b/docs/JVM.md
index 18b3afc..a0d4cda 100644
--- a/docs/JVM.md
+++ b/docs/JVM.md
@@ -2,4 +2,4 @@
[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/jvm.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/jvm.yml)
-TODO: Fill out this README.md with information about the JVM library. \ No newline at end of file
+TODO: Fill out this README.md with information about the JVM library.
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!
+}
+```
diff --git a/docs/Ruby.md b/docs/Ruby.md
new file mode 100644
index 0000000..c79057a
--- /dev/null
+++ b/docs/Ruby.md
@@ -0,0 +1,25 @@
+# locusts
+
+[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/main.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/main.yml)
+![Gem Version](https://img.shields.io/gem/v/locusts?logo=ruby)
+
+## Description
+
+locusts is a library that provides a way to introduce locusts into your code.
+
+## Installation
+
+```sh
+bundle add locusts
+```
+
+## Example
+
+```ruby
+require 'locusts'
+
+def main
+ locusts.introduceLocusts
+ # Locusts are now in your codebase!
+end
+```