diff options
| author | Matt Strapp <matt@mattstrapp.net> | 2024-08-05 14:32:56 -0500 |
|---|---|---|
| committer | Matt Strapp <matt@mattstrapp.net> | 2024-08-05 14:32:56 -0500 |
| commit | 38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 (patch) | |
| tree | ee0b2a7cec961f3f2d04057e269695eddf132afc /docs/Python.md | |
| parent | Nothing? (diff) | |
| download | locusts-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 '')
| -rw-r--r-- | docs/Python.md | 26 |
1 files changed, 26 insertions, 0 deletions
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 |