From dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a Mon Sep 17 00:00:00 2001
From: Bjorn Stange <bjorn248@gmail.com>
Date: Wed, 3 Oct 2018 12:13:48 -0400
Subject: golang: add README (#7207)

---
 plugins/golang/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 plugins/golang/README.md

(limited to 'plugins/golang/README.md')

diff --git a/plugins/golang/README.md b/plugins/golang/README.md
new file mode 100644
index 000000000..72845b2a1
--- /dev/null
+++ b/plugins/golang/README.md
@@ -0,0 +1,29 @@
+# Golang plugin
+
+This plugin adds completion for the [Go Programming Language](https://golang.org/),
+as well as some aliases for common Golang commands.
+
+To use it, add `golang` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... golang)
+```
+
+## Aliases
+
+| Alias   | Command                 | Description                                                   |
+| ------- | ----------------------- | ------------------------------------------------------------- |
+| gob     | `go build`              | Build your code                                               |
+| goc     | `go clean`              | Removes object files from package source directories          |
+| god     | `go doc`                | Prints documentation comments                                 |
+| gof     | `go fmt`                | Gofmt formats (aligns and indents) Go programs.               |
+| gofa    | `go fmt ./...`          | Run go fmt for all packages in current directory, recursively |
+| gog     | `go get`                | Downloads packages and then installs them to $GOPATH          |
+| goi     | `go install`            | Compiles and installs packages to $GOPATH                     |
+| gol     | `go list`               | Lists Go packages                                             |
+| gop     | `cd $GOPATH`            | Takes you to $GOPATH                                          |
+| gopb    | `cd $GOPATH/bin`        | Takes you to $GOPATH/bin                                      |
+| gops    | `cd $GOPATH/src`        | Takes you to $GOPATH/src                                      |
+| gor     | `go run`                | Compiles and runs your code                                   |
+| got     | `go test`               | Runs tests                                                    |
+| gov     | `go vet`                | Vet examines Go source code and reports suspicious constructs |
-- 
cgit v1.2.3-70-g09d2


From 7b2c4327e7d40ec17b72fe7fce3031dfc92fb165 Mon Sep 17 00:00:00 2001
From: Jacky Wu <Colstuwjx@gmail.com>
Date: Fri, 28 Jun 2019 00:49:00 +0800
Subject: golang: add missing gom alias to README (#7961)

---
 plugins/golang/README.md | 1 +
 1 file changed, 1 insertion(+)

(limited to 'plugins/golang/README.md')

diff --git a/plugins/golang/README.md b/plugins/golang/README.md
index 72845b2a1..0a1b43c30 100644
--- a/plugins/golang/README.md
+++ b/plugins/golang/README.md
@@ -21,6 +21,7 @@ plugins=(... golang)
 | gog     | `go get`                | Downloads packages and then installs them to $GOPATH          |
 | goi     | `go install`            | Compiles and installs packages to $GOPATH                     |
 | gol     | `go list`               | Lists Go packages                                             |
+| gom     | `go mod`                | Access to operations on modules                               |
 | gop     | `cd $GOPATH`            | Takes you to $GOPATH                                          |
 | gopb    | `cd $GOPATH/bin`        | Takes you to $GOPATH/bin                                      |
 | gops    | `cd $GOPATH/src`        | Takes you to $GOPATH/src                                      |
-- 
cgit v1.2.3-70-g09d2