aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/locusts.ex19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/locusts.ex b/src/locusts.ex
new file mode 100644
index 0000000..fdcbc0f
--- /dev/null
+++ b/src/locusts.ex
@@ -0,0 +1,19 @@
+defmodule Locusts do
+ @moduledoc """
+ Documentation for `Locusts`.
+ """
+
+ @doc """
+ Introduce locusts into your codebase.
+
+ Note that locusts are not included with this package, you must provide your own.
+
+ ## Examples
+
+ iex> Locusts.introduce_locusts()
+ nil
+
+ """
+ def introduce_locusts do
+ end
+end