From 38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Mon, 5 Aug 2024 14:32:56 -0500 Subject: Add python and a bunch of documentation Signed-off-by: Matt Strapp --- docs/Python.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/Python.md (limited to 'docs/Python.md') diff --git a/docs/Python.md b/docs/Python.md new file mode 100644 index 0000000..768ed33 --- /dev/null +++ b/docs/Python.md @@ -0,0 +1,26 @@ +# locusts-r-us + +## Description +locusts-r-us 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 +```sh +pip install locusts-r-us +``` + +## Example +```python +import locusts + +def main(): + locusts.introduce_locusts() + # Locusts are now in your codebase! + +if __name__ == "__main__": + main() +``` + +## License +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file -- cgit v1.2.3