aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Go.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/Go.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/Go.md b/docs/Go.md
index 6532847..87813d1 100644
--- a/docs/Go.md
+++ b/docs/Go.md
@@ -1,26 +1,30 @@
# 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! */
+ 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
+
+This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details.