aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib.rs13
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 4054f90..a77349a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,16 @@
#![no_std]
-pub fn introduce_locusts(){}
+/// Add locusts to your codebase.
+///
+/// Note that locusts are not included with this package, you must provide your own.
+///
+/// # Examples
+///
+/// ```
+/// use locusts::introduce_locusts;
+///
+/// introduce_locusts();
+/// ```
+pub fn introduce_locusts() {}
#[cfg(test)]
mod tests {