aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Go.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Go.md')
-rw-r--r--docs/Go.md26
1 files changed, 26 insertions, 0 deletions
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