aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Ruby.md
blob: c79057a36543c52f7cff34a4f41685a75c2cc030 (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
# 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
```