docs/Rust.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
32
33
34
35
36
37
38
39

# locusts

[![Rust](https://github.com/locusts-r-us/locusts/actions/workflows/rust.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/rust.yml)

## Description

locusts is a library that provides a way to introduce locusts into your code.

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

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
locusts = "1"
```

or

```sh
cargo add locusts
```

## Example

```rust
use locusts;

fn main() {
 locusts::introduce_locusts();
 // Locusts are now in your codebase!
}
```

## License

This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details.