From f33ddce9267f934332653d78b775a3d29552151b Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Tue, 6 Aug 2024 09:20:36 -0500 Subject: Format all documentation Signed-off-by: Matt Strapp --- docs/Rust.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'docs/Rust.md') 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. -- cgit v1.2.3