From 8d4022d1183a61b7f2bd4f619b2664beccb8b663 Mon Sep 17 00:00:00 2001
From: Matt Strapp <matt@mattstrapp.net>
Date: Fri, 20 Sep 2024 09:32:40 -0500
Subject: Add BEAM

Signed-off-by: Matt Strapp <matt@mattstrapp.net>
---
 docs/BEAM.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 docs/BEAM.md

(limited to 'docs')

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>.
-- 
cgit v1.2.3