aboutsummaryrefslogtreecommitdiffstats
path: root/docs/BEAM.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-09-20 09:32:40 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-09-20 09:32:40 -0500
commit8d4022d1183a61b7f2bd4f619b2664beccb8b663 (patch)
treeccbdba6a3442ca3e3e9ac2fa2f09d7816879b1ec /docs/BEAM.md
parentMake turbo happy (diff)
downloadlocusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar.gz
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar.bz2
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar.lz
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar.xz
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.tar.zst
locusts-8d4022d1183a61b7f2bd4f619b2664beccb8b663.zip
Add BEAM
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'docs/BEAM.md')
-rw-r--r--docs/BEAM.md20
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>.