docs/Ruby.md


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
30
31

# 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 member of a [series of libraries](https://github.com/locusts-r-us/locusts) that allows you to introduce locusts into your codebase.

Why would you want to do that? I don't know.

## Installation

```sh
bundle add locusts
```

## Example

```ruby
require 'locusts'

def main
  locusts.introduceLocusts
  # Locusts are now in your codebase!
end
```

## 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.