aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Rust.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
commit38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 (patch)
treeee0b2a7cec961f3f2d04057e269695eddf132afc /docs/Rust.md
parentNothing? (diff)
downloadlocusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.gz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.bz2
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.lz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.xz
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.tar.zst
locusts-38c5e18b94c1f2f506b89cfa582b4aba80fe48d7.zip
Add python and a bunch of documentation
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'docs/Rust.md')
-rw-r--r--docs/Rust.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/Rust.md b/docs/Rust.md
new file mode 100644
index 0000000..11f232d
--- /dev/null
+++ b/docs/Rust.md
@@ -0,0 +1,29 @@
+# locusts
+
+## Description
+locusts is a library that provides a way to introduce locusts into your code.
+
+Why would you want to do that? I don't know.
+
+## Installation
+Add this to your `Cargo.toml`:
+```toml
+[dependencies]
+locusts = "1"
+```
+or
+```sh
+cargo add locusts
+```
+
+## Example
+```rust
+use locusts;
+
+fn main() {
+ locusts::introduce_locusts();
+ /* Locusts are now in your codebase! */
+}
+```
+## License
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file