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

# :locusts

[![CI](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml/badge.svg)](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml)
![Hex.pm Version](https://img.shields.io/hexpm/v/locusts?logo=erlang)
[![Docs](https://img.shields.io/badge/docs-hexdocs.pm-blue?logo=elixir)](https://hexdocs.pm/locusts)

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

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `locusts` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:locusts, ">= 0.0.0"}
  ]
end
```

Documentation can be generated with
[ExDoc](https://github.com/elixir-lang/ex_doc) and published on
[HexDocs](https://hexdocs.pm). Once published, the docs can be found at
<https://hexdocs.pm/locusts>.

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