aboutsummaryrefslogtreecommitdiffstats
path: root/docs/BEAM.md
blob: 290f3090bf3e31c4b5d4c23851f4492044223655 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Locusts

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

**TODO: Add description**

## 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, "~> 1.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>.