aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Python.md
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-06 09:20:36 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-06 09:42:20 -0500
commitf33ddce9267f934332653d78b775a3d29552151b (patch)
tree7aad50cc832f55990201cab0dfea592c660be94f /docs/Python.md
parentAdd Meson to GHA (diff)
downloadlocusts-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 '')
-rw-r--r--docs/Python.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/Python.md b/docs/Python.md
index 768ed33..6d01754 100644
--- a/docs/Python.md
+++ b/docs/Python.md
@@ -1,26 +1,30 @@
# 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!
+ locusts.introduce_locusts()
+ # Locusts are now in your codebase!
if __name__ == "__main__":
- 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
+
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details.