docs/Go.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

# Locusts

[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/go.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/go.yml)
[![Go Reference](https://pkg.go.dev/badge/github.com/locusts-r-us/locusts.svg)](https://pkg.go.dev/github.com/locusts-r-us/locusts)

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

```sh
go get github.com/locusts-r-us/locusts
```

## Example

```go
package main

import "github.com/locusts-r-us/locusts"

func main() {
 locusts.IntroduceLocusts()
 // Locusts are now in your codebase!
}
```

## License

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