diff options
| author | Matt Strapp <matt@mattstrapp.net> | 2024-08-06 09:20:36 -0500 |
|---|---|---|
| committer | Matt Strapp <matt@mattstrapp.net> | 2024-08-06 09:42:20 -0500 |
| commit | f33ddce9267f934332653d78b775a3d29552151b (patch) | |
| tree | 7aad50cc832f55990201cab0dfea592c660be94f /docs/Rust.md | |
| parent | Add Meson to GHA (diff) | |
| download | locusts-f33ddce9267f934332653d78b775a3d29552151b.tar locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.gz locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.bz2 locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.lz locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.xz locusts-f33ddce9267f934332653d78b775a3d29552151b.tar.zst locusts-f33ddce9267f934332653d78b775a3d29552151b.zip | |
Format all documentation
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
Diffstat (limited to 'docs/Rust.md')
| -rw-r--r-- | docs/Rust.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/Rust.md b/docs/Rust.md index 11f232d..b01a943 100644 --- a/docs/Rust.md +++ b/docs/Rust.md @@ -1,29 +1,37 @@ # 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! */ + 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 + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. |