aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
committerMatt Strapp <matt@mattstrapp.net>2024-08-05 14:32:56 -0500
commit38c5e18b94c1f2f506b89cfa582b4aba80fe48d7 (patch)
treeee0b2a7cec961f3f2d04057e269695eddf132afc /docs
parentNothing? (diff)
downloadlocusts-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/C.md4
-rw-r--r--docs/Go.md26
-rw-r--r--docs/Python.md26
-rw-r--r--docs/Rust.md29
4 files changed, 82 insertions, 3 deletions
diff --git a/docs/C.md b/docs/C.md
index c5e2094..27ea047 100644
--- a/docs/C.md
+++ b/docs/C.md
@@ -37,7 +37,5 @@ autoreconf -fi
make
```
-
## License
-This project is licensed under the BSD Zero Clause License. See the [LICENSE](LICENSE) file for details.
-```
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file
diff --git a/docs/Go.md b/docs/Go.md
new file mode 100644
index 0000000..6532847
--- /dev/null
+++ b/docs/Go.md
@@ -0,0 +1,26 @@
+# 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
+```sh
+go get github.com/locusts-r-us/locusts
+```
+
+## Example
+```go
+package main
+
+import "github.com/locusts-r-us/locusts"
+
+func main() {
+ locusts.IntroduceLocusts()
+ /* 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
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
diff --git a/docs/Rust.md b/docs/Rust.md
new file mode 100644
index 0000000..11f232d
--- /dev/null
+++ b/docs/Rust.md
@@ -0,0 +1,29 @@
+# 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! */
+}
+```
+## License
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file