diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/BEAM.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/BEAM.md b/docs/BEAM.md new file mode 100644 index 0000000..ae5db8b --- /dev/null +++ b/docs/BEAM.md @@ -0,0 +1,20 @@ +# Locusts + +**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, "~> 0.1.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>. |