diff options
Diffstat (limited to 'docs/BEAM.md')
| -rw-r--r-- | docs/BEAM.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/BEAM.md b/docs/BEAM.md new file mode 100644 index 0000000..de0852d --- /dev/null +++ b/docs/BEAM.md @@ -0,0 +1,34 @@ +# :locusts + +[](https://github.com/locusts-r-us/locusts/actions/workflows/beam.yml) + +[](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. |