diff options
Diffstat (limited to 'docs/Rust.md')
-rw-r--r-- | docs/Rust.md | 29 |
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 |